OpenAPI

# 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 OpenAPI document for exact field names, types, and shapes. Use these prose docs for product meaning, delivery semantics, and safe guidance. The two are complementary; neither replaces the other.


- Artifact: OpenAPI JSON; URL: https://docs.flowrelay.app/reference/openapi/agent-operations.openapi.json
- Artifact: Trigger mapping reference; URL: https://docs.flowrelay.app/setup/trigger-variants-and-event-mapping/
- Artifact: Choose an agent mission; URL: https://docs.flowrelay.app/agent-access/agent-mission-playbooks/
- Artifact: Availability and refusals; URL: https://docs.flowrelay.app/agent-access/availability-and-refusals/
- Artifact: Agent orientation; URL: https://docs.flowrelay.app/agent-access/agent-orientation/
- Artifact: Docs index; URL: https://docs.flowrelay.app/llms.txt

## Versioning
The current generated Agent Operations schema version is 2026-06-17. Generated schema versions move with the canonical operation registry; agents re-read the manifest and OpenAPI document before relying on cached operation names or schemas.


## Operation names
Use generated operation IDs for clients. The public manifest operation is getAgentOperationsManifest. Keep examples synthetic and redacted, and do not include real tokens, authentication headers, event bodies, or customer records.


## Examples
The generated OpenAPI document includes synthetic request examples for endpoint creation, replay preview and execution, diagnostics sharing, support preview and submit, expansion requests, and feature requests. Use those schema-bound examples instead of copying production requests.

### Inspect the generated examples
Lists operation IDs that include request-body examples.

```sh
curl -s https://docs.flowrelay.app/reference/openapi/agent-operations.openapi.json \
  | jq -r '.paths[][] | select(.operationId) | .operationId'
```


## Generated clients
If you generate a client from the schema, preserve refusal handling, idempotency keys, docs URLs in refusals, and the action-preview lifecycle. These behaviors are part of the Agent Operations contract and must remain visible in your client.


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

## Safety Boundary
Do not share endpoint secrets, authentication headers, HMAC values, tokens, raw event bodies, customer records, Shopify sessions, store passwords, or database URLs in public examples.