OpenPhonexDocs

REST endpoints

The key REST endpoints — agents, web/trial calls, numbers, calls, messages, and wallet/usage.

No MCP client? Every capability is also a plain JSON REST endpoint under /v1. Authenticate with the same scoped tai_ key as a Bearer token. The OpenAPI spec is the machine-readable source of truth; this is the human map.

Building a customer application?

Start with Customer applications, then connect live data through Integrations. The Generated API reference lists the current customer SDK operation set from the canonical OpenAPI snapshot.

Agents

MethodPathPurpose
POST/v1/agentsCreate an agent (external_audio, external_text, hosted).
POST/v1/agents/{id}/voice-stackSet the STT/LLM/TTS stack.

Calls

MethodPathPurpose
POST/v1/trial-callsCreate a shared-number trial call PIN.
POST/v1/calls/outboundPlace a policy-gated outbound call.
GET/v1/callsList calls.
GET/v1/calls/{id}Call status + recording state.

Numbers

MethodPathPurpose
GET/v1/coverageCountry coverage matrix.
POST/v1/number-requestsRequest a managed number (operator-approved).
GET/v1/numbersList numbers and registration status.
GET PUT/v1/numbers/{id}/rulesRead / update number rules.

Messages

MethodPathPurpose
GET/v1/conversationsList SMS conversations.
POST/v1/messagesSend a policy-gated SMS.

Wallet & usage

MethodPathPurpose
GET/v1/account/overviewWallet, agents, numbers, usage rollup.

Keys & scopes are identical to MCP

REST and MCP share the same scoped keys and the same fail-closed scope checks. See Authentication & keys.

On this page