API overview

The Tried REST API manages agents, phone numbers, calls, chats, knowledge bases and everything else you can do in the dashboard. Paths and payloads follow Retell's API, so code written for Retell runs against Tried after you change the base URL and the key.

Base URL#

https://api.tried.com.au

All requests use HTTPS. Request and response bodies are JSON (Content-Type: application/json), except file uploads, which use multipart/form-data, and a few downloads.

Authentication#

Send a secret API key as a bearer token on every request:

curl https://api.tried.com.au/v2/list-agents \
  -H "Authorization: Bearer $TRIED_API_KEY"

Create keys under Settings, API Keys in the dashboard. Keys can be limited by scope, IP address and rate. Browsers use public keys instead. See Authentication.

Using the Retell SDKs#

The Retell Node and Python SDKs accept a base URL. Point it at Tried and use a Tried key:

import Retell from "retell-sdk";

const client = new Retell({
  apiKey: process.env.TRIED_API_KEY!,
  baseURL: "https://api.tried.com.au",
});

const call = await client.call.createPhoneCall({
  from_number: "+61291234567",
  to_number: "+61412345678",
});

import os
from retell import Retell

client = Retell(
    api_key=os.environ["TRIED_API_KEY"],
    base_url="https://api.tried.com.au",
)

call = client.call.create_phone_call(
    from_number="+61291234567",
    to_number="+61412345678",
)

Things to know when you switch:

• Tried documents its own fields on each endpoint page. Fields Retell has and Tried does not are dropped from request bodies without an error, so check the page for any field you rely on.
• Webhooks are signed with x-tried-signature and also with x-retell-signature, so existing Retell verification code keeps working. See Webhooks.
• For browser web calls, the @tried/web-sdk client mirrors Retell's RetellWebClient (startCall({ accessToken }), stopCall(), mute(), the same events). Pass the access_token and livekit_url from Create web call.
• Endpoints that Retell does not have (for example alerts and analytics dashboards) have no method in the Retell SDKs. Call them over plain HTTP with the same header.

Path versions#

Paths match Retell's, including its version prefixes. Where Retell uses /v2/ or /v3/, Tried serves the same path, and for most of them it also serves the other form as an alias:

Use the canonical path in new code. Version references on an agent (agent_version, override_agent_version) and environment tags are resolved on the canonical create-call paths.

There is no API version header. The version is part of the path.

Requests#

• Field names are snake_case.
• Validation. Every body is checked against a schema. Invalid values return 400 with the failing field named, for example to_number: Required.
• Unknown fields are dropped, not rejected.
• Server-controlled fields such as IDs, version, is_published, timestamps and costs are never read from the body.
• Size. JSON bodies up to 25 MB. Knowledge base files up to 50 MB each and 25 per request.
• Phone numbers are E.164 strings, such as +61291234567 or +14155550123. A phone number is its own ID in paths, for example /get-phone-number/+61291234567 (URL-encode the + as %2B if your client does not).
• Idempotency. POST /v2/create-phone-call accepts an idempotency_key (up to 200 characters). A repeat with the same key within 1 hour returns the original call instead of dialling again.

Responses#

• Objects are returned as JSON with snake_case fields. Create endpoints return 201. Most deletes return 204 with no body.
• Timestamps are integers in Unix epoch milliseconds, such as start_timestamp: 1760832000000. Durations end in _ms.
• Errors return { "status": <code>, "message": "<text>" }. See Errors.

IDs#

IDs are a type prefix and 24 random hex characters:

The secret value of an API key is longer (key_ and 48 hex characters) than its api_key_id. An ID from another workspace returns 404.

Pagination#

Most list endpoints return a JSON array, newest first, and take an optional limit query parameter (each page lists its default and maximum).

POST /v3/list-calls pages with a cursor, the same way as Retell:

1. Send limit (1 to 1000, default 50) and sort_order (descending by default).
2. Take the call_id of the last call in the response.
3. Send it as pagination_key to get the next page. An unknown key returns 400 with Invalid pagination_key.

List contact conversations returns next_before. Pass it back as before for the next page.

Rate limits#

The default is 600 requests per minute per API key and 3000 per IP address. Responses carry x-ratelimit-* headers. See Rate limits.

Endpoints#

Every endpoint, grouped by resource. Each page has the request fields, an example in cURL, Node and Python, the response and the errors it returns.

Calls#

Chats and SMS#

Voice agents#

Chat agents#

Response engines#

Conversation flows#

Phone numbers#

Voices#

Knowledge bases#

Batch calls#

Contacts#

Testing#

Integrations#

Account#

Realtime and SDK#

Public endpoints#