メインコンテンツへスキップ
GET
Get Agent

承認

Authorization
string
header
必須

Cartesia API key (sk_car_...). Get one at play.cartesia.ai/keys.

ヘッダー

Cartesia-Version
enum<string>
デフォルト:2026-03-01
必須

API version header.

利用可能なオプション:
2026-03-01
:

"2026-03-01"

パスパラメータ

agent_id
string
必須

The ID of the agent.

レスポンス

200 - application/json

A summary of essential information about an agent.

id
string
必須

The ID of the agent.

name
string
必須

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

created_at
string<date-time>
必須

The date and time when the agent was created.

updated_at
string<date-time>
必須

The date and time when the agent was last updated.

tts_voice
string
必須

The text-to-speech voice used by the agent.

tts_language
string
必須

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

noise_suppression_level
integer
必須

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

必須範囲: 0 <= x <= 100
has_text_to_agent_run
boolean
必須

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

deployment_count
integer
必須

The number of deployments associated with the agent.

description
string | null

A brief description of the agent.

webhook_id
string | null

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_at
string<date-time> | null

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

git_repository
GitRepository · object | null

The Git repository associated with the agent.

git_deploy_branch
string | null

The branch of the Git repository used for deployment.

phone_numbers
PhoneNumberSummary · object[] | null

The phone numbers associated with the agent. Currently, you can only have one phone number per agent.