Sign in

v1

latestOpenAPI 3.0.12026-07-2696152184.1 KB
Agents

Get Agent

Returns the details of a specific agent

get/agents/{agent_id}

Path parameters

agent_idstring required

The ID of the agent.

Headers

Cartesia-Version'2026-03-01' date required
Example:2026-03-01

API version header.

Response

idstring required

The ID of the agent.

namestring required

The unique name of the agent, which can be used to identify the agent in the CLI.

descriptionstring nullable

A brief description of the agent.

created_atstring date-time required

The date and time when the agent was created.

updated_atstring date-time required

The date and time when the agent was last updated.

tts_voicestring required

The ID of the voice. Find one in the Voice Library or via List Voices.

tts_languagestring required

The language used for text-to-speech by the agent.

noise_suppression_levelinteger required

The level of noise suppression applied to the caller's audio, from 0 (off) to 100 (maximum).

webhook_idstring nullable

The identifier for the webhook associated with the agent. Add or customize a webhook to your agent to receive events when calls are made to your agent via the Playground.

deleted_atstring date-time nullable

The date and time when the agent was deleted, if applicable.

git_deploy_branchstring nullable

The branch of the Git repository used for deployment.

has_text_to_agent_runboolean required

Whether the agent has a text-to-agent run.

deployment_countinteger required

The number of deployments associated with the agent.

Example response

{
  "git_repository": {
    "provider": "github"
  }
}
All 96 operations