SpeechifyAI Agents API

REST endpoints for defining agents, dispatching realtime conversations, and managing knowledge, tools, and telephony

Agents is in beta. The product is stable enough for production traffic, but request and response shapes may still change before general availability. Pin a dated API version and check the changelog before upgrading.

The SpeechifyAI Agents API is a REST API at https://api.speechify.ai. Use it to define agents, dispatch realtime voice sessions, and manage the knowledge, tools, and telephony that power each conversation.

Agents are reusable configurations - prompt, voice, tools, knowledge, and evaluation criteria. When you dispatch a conversation, the API provisions a low-latency voice session and returns a short-lived token your client uses to connect.

Explore

Agents

Create, configure, and manage the base agent surface: prompt, voice, first message, and widget config.

Conversations

Dispatch calls, list conversations, and pull transcripts, evaluations, memories, and recordings.

Knowledge Bases

Create knowledge bases, upload documents, crawl URLs, and attach knowledge to agents.

Tools

Attach webhook, MCP, or built-in tools so an agent can act during a call.

Telephony

Purchase numbers, place outbound calls, batch dial, and monitor IVR menus.

Tests

Define replay, simulation, and tool tests, run suites, and pull results.

Response format

All endpoints return JSON. Every non-2xx response uses the same envelope:

1{
2  "error": {
3    "code": "agent_not_found",
4    "message": "Agent 'agent_demo0001' does not exist or is not accessible to this workspace."
5  },
6  "request_id": "7f3a2c1b4d5e6f7a"
7}

Check error.code in your exception handler - it is stable and machine-readable. error.message is human-friendly and may change between releases. error.fields carries per-field validation errors when relevant. request_id echoes the X-Request-ID response header; quote it when filing support tickets.

See Get started for authentication and limits, and Idempotency for safe retries on dispatch, batch, and purchase endpoints.