Get agent

Retrieve a voice agent, the latest version or a specific one.

GEThttps://api.tried.com.au/get-agent/{agent_id}

Returns one version of an agent. Without version you get the latest version, which is the editable draft.

Request#

Path parameters#

Parameter	Type	Required	Description
`agent_id`	string	Yes	The agent.

Query parameters#

Parameter	Type	Required	Description
`version`	integer or string	No	A version number, or a version reference: `latest`, `latest_published` or an environment tag name such as `prod`. Default: latest.

Example request#

curl "https://api.tried.com.au/get-agent/agent_3f9a1c0b2d4e5f6a7b8c9d0e?version=latest_published" \
  -H "Authorization: Bearer $TRIED_API_KEY"

const res = await fetch("https://api.tried.com.au/get-agent/agent_3f9a1c0b2d4e5f6a7b8c9d0e?version=latest_published", {
  headers: { Authorization: `Bearer ${process.env.TRIED_API_KEY}` },
});
const data = await res.json();

import os, requests

res = requests.get(
    "https://api.tried.com.au/get-agent/agent_3f9a1c0b2d4e5f6a7b8c9d0e?version=latest_published",
    headers={"Authorization": f"Bearer {os.environ['TRIED_API_KEY']}"},
)
data = res.json()

Response#

200 OK with the agent.

Errors#

Status	When
`400`	`version` is not a known reference, or the agent has no published version (`latest_published`).
`401`	Missing or invalid API key.
`403`	The key's IP allowlist or scopes reject the request. This route needs the `agents` scope.
`404`	The agent or version does not exist.
`429`	Rate limit exceeded. See Rate limits.

See Errors for the body format.