# OpenAPI

Canonical: https://docs.flowrelay.app/reference/openapi/
Markdown: https://docs.flowrelay.app/reference/openapi.md

Generated OpenAPI schema discovery and public contract placement for Agent Operations.

## Schema location
Use the generated OpenAPI document for exact request and response fields. Use the prose docs for product meaning and safe operating guidance.

- Artifact: OpenAPI JSON; URL: https://docs.flowrelay.app/reference/openapi/agent-operations.openapi.json
- Artifact: Agent orientation; URL: https://docs.flowrelay.app/agent-access/agent-orientation/
- Artifact: Docs index; URL: https://docs.flowrelay.app/llms.txt

## Versioning
Generated schema versions move with the Agent Operations contract. Agents re-read the manifest and OpenAPI document before relying on cached operation names or schemas.

## Operation names
Use stable operation IDs for generated clients. Keep docs examples synthetic and redacted, and do not include real tokens, auth headers, payloads, or customer records.

## Generated clients
Generated clients preserve refusal handling, idempotency, docs URLs, and action-intent semantics rather than hiding those details behind a generic SDK.

## Example Surface
- `GET /reference/openapi/agent-operations.openapi.json`
- `operationId: getAgentManifest`
- `x-flowrelay-docs.docsIndex`

## Safety Boundary
Do not include raw payloads, endpoint secrets, auth headers, HMAC values, Shopify tokens, Shopify sessions, database URLs, customer data, merchant incidents, or copied private logs in public examples.