Skip to main content
Use Threetone’s REST API from your server-side Python or TypeScript application. The language pages provide read examples with authentication, timeouts, response checks, and pagination.
First-party Python and TypeScript SDKs are planned. No verified installable first-party SDK release has been identified. The examples use Requests and Node.js fetch; there is no Threetone package installation or SDK import to copy yet.

​
Choose a language

Python SDK

Check planned SDK availability and list agents with Requests.

TypeScript SDK

Check planned SDK availability and list agents with Node.js fetch.

​
Prepare your integration

  1. Create a personal API key with access to the resources you need.
  2. Keep the key in server-side configuration and send it in the x-api-key header. Read Authentication for credential requirements.
  3. Start with List agents, then use Get agent to inspect an existing configuration.
  4. Retain the status code and request ID when a request fails. Use Errors and retries before adding retries.
The read examples do not create resources, publish versions, or start sessions. Review current availability before building an execution workflow. Voice and custom-LLM configuration publication are currently unavailable.

​
Work with the public contract

Use the endpoint reference for request fields, response fields, and permissions. An endpoint’s presence in the reference does not establish that every associated runtime feature is available. For agent lists, choose a page_size between 1 and 100. The default is 30. Follow the returned next_cursor while has_more is true, keeping the same filters between pages. Treat the cursor as an opaque value.

​
Frequently asked questions

No verified first-party package release is documented here. Use the REST examples until a package name, supported version, and installation instructions are published.
Keep personal API keys on your server. Call your own authenticated server route from the browser and let that route make the Threetone request.
No. A successful read confirms access to the stored record. Session access, publication, and execution have separate requirements and availability limits.