# Request 1: List all trainings for an agent
curl -X GET "https://app.talkover.ai/api/v1/agents/550e8400-e29b-41d4-a716-446655440000/trainings" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Request 1: List all trainings for an agent
const response = await fetch('https://app.talkover.ai/api/v1/agents/550e8400-e29b-41d4-a716-446655440000/trainings', {
method: 'GET',
headers: {
'Authorization': 'Bearer talq_your_environment_token_here'
}
});
const result = await response.json();
console.log(result);
{
"success": true,
"data": [
{
"id": "training-uuid-1",
"subject": "Product Knowledge",
"instructions": "Learn about our product features, pricing, and common use cases. Focus on the main benefits and how to address common customer questions.",
"current_status": "active",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
},
{
"id": "training-uuid-2",
"subject": "Customer Service Best Practices",
"instructions": "Understand how to handle customer complaints and provide excellent service. Always be polite, patient, and solution-oriented.",
"current_status": "active",
"created_at": "2024-01-15T11:00:00Z",
"updated_at": "2024-01-15T11:00:00Z"
},
{
"id": "training-uuid-3",
"subject": "Technical Support",
"instructions": "Provide technical support for common issues. Guide users through troubleshooting steps and escalate when necessary.",
"current_status": "inactive",
"created_at": "2024-01-15T12:00:00Z",
"updated_at": "2024-01-15T12:00:00Z"
}
]
}
Trainings
List Trainings
Retrieve a list of training data for a specific voice agent
GET
/
api
/
v1
/
agents
/
{agent_id}
/
trainings
# Request 1: List all trainings for an agent
curl -X GET "https://app.talkover.ai/api/v1/agents/550e8400-e29b-41d4-a716-446655440000/trainings" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Request 1: List all trainings for an agent
const response = await fetch('https://app.talkover.ai/api/v1/agents/550e8400-e29b-41d4-a716-446655440000/trainings', {
method: 'GET',
headers: {
'Authorization': 'Bearer talq_your_environment_token_here'
}
});
const result = await response.json();
console.log(result);
{
"success": true,
"data": [
{
"id": "training-uuid-1",
"subject": "Product Knowledge",
"instructions": "Learn about our product features, pricing, and common use cases. Focus on the main benefits and how to address common customer questions.",
"current_status": "active",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
},
{
"id": "training-uuid-2",
"subject": "Customer Service Best Practices",
"instructions": "Understand how to handle customer complaints and provide excellent service. Always be polite, patient, and solution-oriented.",
"current_status": "active",
"created_at": "2024-01-15T11:00:00Z",
"updated_at": "2024-01-15T11:00:00Z"
},
{
"id": "training-uuid-3",
"subject": "Technical Support",
"instructions": "Provide technical support for common issues. Guide users through troubleshooting steps and escalate when necessary.",
"current_status": "inactive",
"created_at": "2024-01-15T12:00:00Z",
"updated_at": "2024-01-15T12:00:00Z"
}
]
}
List Trainings
Retrieve all training data associated with a specific voice agent. This endpoint returns a list of training instructions that the agent uses to understand how to respond to different scenarios.Endpoint
GET /api/v1/agents/{agent_id}/trainings
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
# Request 1: List all trainings for an agent
curl -X GET "https://app.talkover.ai/api/v1/agents/550e8400-e29b-41d4-a716-446655440000/trainings" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Request 1: List all trainings for an agent
const response = await fetch('https://app.talkover.ai/api/v1/agents/550e8400-e29b-41d4-a716-446655440000/trainings', {
method: 'GET',
headers: {
'Authorization': 'Bearer talq_your_environment_token_here'
}
});
const result = await response.json();
console.log(result);
# Request 2: List trainings with error handling
curl -X GET "https://app.talkover.ai/api/v1/agents/550e8400-e29b-41d4-a716-446655440000/trainings" \
-H "Authorization: Bearer talq_your_environment_token_here" \
-w "\nHTTP Status: %{http_code}\n"
// Request 2: List trainings with error handling
try {
const response = await fetch('https://app.talkover.ai/api/v1/agents/550e8400-e29b-41d4-a716-446655440000/trainings', {
method: 'GET',
headers: {
'Authorization': 'Bearer talq_your_environment_token_here'
}
});
if (!response.ok) {
throw new Error(`HTTP error! status: ${response.status}`);
}
const result = await response.json();
console.log('Trainings:', result.data);
} catch (error) {
console.error('Error fetching trainings:', error);
}
Response
Success Response (200 OK)
{
"success": true,
"data": [
{
"id": "training-uuid-1",
"subject": "Product Knowledge",
"instructions": "Learn about our product features, pricing, and common use cases. Focus on the main benefits and how to address common customer questions.",
"current_status": "active",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
},
{
"id": "training-uuid-2",
"subject": "Customer Service Best Practices",
"instructions": "Understand how to handle customer complaints and provide excellent service. Always be polite, patient, and solution-oriented.",
"current_status": "active",
"created_at": "2024-01-15T11:00:00Z",
"updated_at": "2024-01-15T11:00:00Z"
},
{
"id": "training-uuid-3",
"subject": "Technical Support",
"instructions": "Provide technical support for common issues. Guide users through troubleshooting steps and escalate when necessary.",
"current_status": "inactive",
"created_at": "2024-01-15T12:00:00Z",
"updated_at": "2024-01-15T12:00:00Z"
}
]
}
Response fields
boolean
required
Indicates if the operation was successful.
array
required
Array of training objects associated with the agent.
Show Training Object
Show Training Object
string
required
Unique identifier for the training.
string
required
The subject or title of the training.
string
required
Detailed instructions for the training that the agent will learn from.
string
required
Current status of the training. Options:
active, inactive.string
required
ISO 8601 timestamp when the training was created.
string
required
ISO 8601 timestamp when the training was last updated.
Error responses
404 Not Found
{
"success": false,
"message": "Agent not found"
}
401 Unauthorized
{
"success": false,
"message": "Unauthenticated."
}
403 Forbidden
{
"success": false,
"message": "You are not authorized to access this agent's trainings."
}
500 Server Error
{
"success": false,
"message": "Internal server error."
}
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 |
SERVER_ERROR | Internal server error occurred | 500 |
Important notes
Empty response is normal. If an agent has no training data, the response will be an empty array
[] rather than an error.Status filtering. The response includes both active and inactive trainings. You can filter by
current_status on the client side if needed.Related endpoints
- Create/Update Training:
POST /api/v1/agents/{agent_id}/trainings - Delete Training:
DELETE /api/v1/agents/{agent_id}/trainings/{training_id} - Get Agent:
GET /api/v1/agents/{agent_id} - List Agents:
GET /api/v1/agents
Was this page helpful?