Skip to main content
GET
/
v1
/
agents
/
{agent_id}
Retrieve an agent
curl --request GET \
  --url https://agents.assemblyai.com/v1/agents/{agent_id} \
  --header 'Authorization: <api-key>'
{
  "id": "7ad24396-b822-4dca-871a-be9cc4781cf9",
  "name": "Support Assistant",
  "system_prompt": "<string>",
  "greeting": "<string>",
  "voice": {
    "voice_id": "ivy"
  },
  "input": {
    "type": "audio",
    "format": {
      "encoding": "audio/pcm",
      "sample_rate": 24000
    },
    "turn_detection": {},
    "keyterms": [
      "<string>"
    ]
  },
  "output": {
    "type": "audio",
    "voice": "ivy",
    "format": {
      "encoding": "audio/pcm",
      "sample_rate": 24000
    },
    "volume": 123
  },
  "tools": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "http": {
        "url": "<string>",
        "headers": {
          "Authorization": "***"
        }
      },
      "parameters": {
        "type": "object",
        "properties": {
          "order_id": {
            "type": "string",
            "description": "The customer's order ID.",
            "examples": [
              "AB-12345"
            ],
            "pattern": "[A-Z]{2}-\\d{5}"
          }
        },
        "required": [
          "order_id"
        ]
      },
      "timeout_seconds": 123
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Your AssemblyAI API key in the Authorization header. The raw key works directly; a Bearer prefix is also accepted.

Path Parameters

agent_id
string
required

The agent's unique ID.

Example:

"7ad24396-b822-4dca-871a-be9cc4781cf9"

Response

The agent record.

A stored voice agent.

id
string
Example:

"7ad24396-b822-4dca-871a-be9cc4781cf9"

name
string
Example:

"Support Assistant"

system_prompt
string
greeting
string | null
voice
object
input
object

Audio input configuration. Defaults to PCM at 24 kHz if omitted.

output
object

Audio output configuration. Defaults to PCM at 24 kHz with the agent's voice.

tools
object[]
created_at
string<date-time>
updated_at
string<date-time>