Skip to main content
GET
/
v1
/
voiceai
/
agents
/
{agent_id}
Get Agent
curl --request GET \
  --url https://api.example.com/v1/voiceai/agents/{agent_id}
{
  "agent_id": "<string>",
  "name": "<string>",
  "conversation_config": {
    "language": "<string>",
    "voice_id": "<string>",
    "first_message": "<string>",
    "system_prompt": "<string>",
    "temperature": 123,
    "use_rag": true,
    "tools": [
      {
        "name": "<string>",
        "description": "<string>",
        "enabled": true
      }
    ]
  },
  "created_at": 123,
  "phone_number_id": "<string>",
  "knowledge_base": [],
  "phone_numbers": []
}

Headers

x-api-key
string | null

API key for authentication

Path Parameters

agent_id
string
required

The ID of the agent to retrieve

Response

Successful Response

agent_id
string
required
name
string
required
conversation_config
ConversationConfig · object
required
created_at
integer | null
phone_number_id
string | null
knowledge_base
KnowledgeBaseItem · object[]
phone_numbers
PhoneNumberDetail · object[]