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
string
required
The unique identifier of the voice agent.
Request headers
string
required
Bearer token for authentication. Format:
Bearer talq_your_environment_token_hereExample requests
Response
Success Response (200 OK)
Response fields
string
required
Unique identifier for the agent.
string
required
The name of the agent.
string
required
The display label for the agent.
string
Description of the agent’s purpose and functionality.
string
required
The language the agent speaks. Format:
en-US, pt-BR, etc.object
Voice configuration for the agent.
string
The first message the agent will say when a call starts.
string
required
How sensitive the agent is to interruptions. Options:
low, medium, high.number
required
Speed of the agent’s speech (0.1 to 3.0).
integer
required
Delay before the agent starts speaking (0 to 60 seconds).
boolean
required
Whether the agent asks if a human is present when idle.
string
required
Call direction. Options:
inbound, outbound.string
required
Who initiates the conversation. Options:
agent, user.string
required
Current status of the agent. Options:
draft, published.boolean
required
Whether the agent is in sandbox mode.
boolean
required
Whether the agent is ready to be published.
string
required
ISO 8601 timestamp when the agent was created.
string
required
ISO 8601 timestamp when the agent was last updated.
array
Array of training data associated with the agent.
array
Array of actions (webhooks, transfers, etc.) associated with the agent.
array
Array of phone numbers associated with the agent.
Error responses
404 Not Found
401 Unauthorized
403 Forbidden
Error codes
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}