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.

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.

Scopes & permissions

The scope catalog, prefix scopes, and fail-closed semantics that make a key a permission boundary.

OpenAPI

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

On this page

AgentsCallsNumbersMessagesWallet & usage