Skip to main content
The Threetone API exposes the Agents Platform and shared workspace resources through a versioned REST interface. Endpoint pages in this reference are generated from the public OpenAPI contract used by the API server.

​
Base URL

All public endpoints begin with /v1. Send requests over HTTPS.

​
Authentication

Programmatic requests use an API key in the x-api-key header.
cURL
Create and manage keys on the API Keys page. Keep each key in a server-side secret store and grant only the permissions its integration needs. See Authentication for credential handling and common authentication failures.

​
Resources

The API reference is organized by resource:
  • Agents Platform contains agents, conversations, tests, tools, knowledge bases, telephony, integrations, MCP servers, and batch calls.
  • Workspace contains members, invitations, groups, service accounts, API key policies, audit logs, webhooks, and usage.
  • Shared resources contains resources used across platform features, such as voices.
  • Utilities contains supporting operations, such as local time-zone resolution.
Work Platform will have its own section when its public API is available.

​
Responses

Successful responses use the status code and schema shown on each endpoint page. Most responses are JSON. Download operations can return another documented media type, such as CSV. List operations document their own filters and pagination fields. Do not assume every list endpoint uses the same cursor or response envelope.

​
Request IDs

Threetone returns an X-Request-Id response header. Keep it with the request method, path, timestamp, and response status when troubleshooting. You may send a valid X-Request-Id header to correlate a request with your own logs.

​
Rate limits

Production requests are rate limited. Successful responses can include X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset. A 429 Too Many Requests response also includes Retry-After. Limits are deployment and credential specific, so read the response headers instead of relying on a fixed value. See Errors and retries for response shapes and retry guidance.