OpenPhonexDocs

OpenAPI

The live, machine-readable OpenAPI spec for the OpenPhonex API.

The OpenPhonex API ships a live OpenAPI 3 document. It is the machine-readable source of truth for every REST endpoint, request/response schema, and auth requirement — generated from the running service.

Open the spec

Point any OpenAPI-aware client at it — Swagger UI, Postman, an SDK generator, or an agent that reads OpenAPI directly. The same scoped tai_ Bearer key authenticates every operation.

Generated reference and handwritten guides

The Generated API reference is a deterministic index of customer SDK operations built from a checked-in snapshot of that canonical OpenAPI schema. The snapshot lets the docs build and review offline; it is not a second hand-maintained API contract. Exact request/response detail remains in the live OpenAPI document.

Conceptual pages are deliberately handwritten because schemas cannot explain product ownership or safe use. Read Integrations for the signed Action protocol, Customer applications for the call lifecycle, and Post-call results for signed events and advisory extraction.

Two agent-readable surfaces

/control-plane/openapi.json is the API surface. The Agent surface pages describe the docs/blog corpus — this site's /llms.txt, /llms-full.txt, and the .md on every page. An agent can pull both to get the full picture.

On this page