FlowRelay Docs Shopify Flow
All docs pages

START

USE CASES

SET UP

OPERATE

RECOVER

AGENT ACCESS

REFERENCE

Reference

OpenAPI

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.

ArtifactURL
OpenAPI JSONhttps://docs.flowrelay.app/reference/openapi/agent-operations.openapi.json
Agent orientationhttps://docs.flowrelay.app/agent-access/agent-orientation/
Docs indexhttps://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.