Agents
Get Agent
Retrieve details of a specific voice agent by ID
GET
Get Agent
Retrieve detailed information about a specific voice agent, including its configuration, voice settings, trainings, actions, and phone numbers.Endpoint
Path parameters
The unique identifier of the voice agent.
Request headers
Bearer token for authentication. Format:
Bearer talq_your_environment_token_hereExample requests
Response
Success Response (200 OK)
Response fields
Unique identifier for the agent.
The name of the agent.
The display label for the agent.
Description of the agent’s purpose and functionality.
The language the agent speaks. Format:
en-US, pt-BR, etc.Voice configuration for the agent.
The first message the agent will say when a call starts.
How sensitive the agent is to interruptions. Options:
low, medium, high.Speed of the agent’s speech (0.1 to 3.0).
Delay before the agent starts speaking (0 to 60 seconds).
Whether the agent asks if a human is present when idle.
Call direction. Options:
inbound, outbound.Who initiates the conversation. Options:
agent, user.Current status of the agent. Options:
draft, published.Whether the agent is in sandbox mode.
Whether the agent is ready to be published.
ISO 8601 timestamp when the agent was created.
ISO 8601 timestamp when the agent was last updated.
Array of training data associated with the agent.
Array of actions (webhooks, transfers, etc.) associated with the agent.
Array of phone numbers associated with the agent.
Error responses
404 Not Found
401 Unauthorized
403 Forbidden
Error codes
| Code | Description | HTTP Status |
|---|---|---|
AGENT_NOT_FOUND | Specified agent does not exist | 404 |
INVALID_TOKEN | Authentication token is invalid or missing | 401 |
UNAUTHORIZED | User does not have permission to access this agent | 403 |
Related endpoints
- List Agents:
GET /api/v1/agents - Create Agent:
POST /api/v1/agents - Update Agent Knowledge:
PUT /api/v1/agents/{agent_id}/knowledge - Update Agent Voice:
PUT /api/v1/agents/{agent_id}/voice - Update Agent Calling Settings:
PUT /api/v1/agents/{agent_id}/calling - Publish Agent:
POST /api/v1/agents/{agent_id}/publish - Unpublish Agent:
POST /api/v1/agents/{agent_id}/unpublish - Delete Agent:
DELETE /api/v1/agents/{agent_id}