# Requisição 1: Obter todos os treinamentos de um agente
curl -X GET "https://app.talkover.ai/api/v1/agents/agent-uuid-1/trainings" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Requisição 1: Obter todos os treinamentos de um agente
const response = await fetch('https://app.talkover.ai/api/v1/agents/agent-uuid-1/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",
"question": "Como posso ajudar com informações sobre produtos?",
"answer": "Posso fornecer informações detalhadas sobre nossos produtos, incluindo especificações, preços e disponibilidade. Qual produto você gostaria de conhecer?",
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
},
{
"id": "training-uuid-2",
"question": "Qual é o processo de suporte técnico?",
"answer": "Para suporte técnico, posso ajudá-lo a identificar o problema e orientá-lo sobre os próximos passos. Posso também agendar um técnico se necessário.",
"created_at": "2024-01-01T01:00:00Z",
"updated_at": "2024-01-01T01:00:00Z"
}
],
"pagination": {
"current_page": 1,
"last_page": 3,
"per_page": 20,
"total": 50,
"from": 1,
"to": 20
}
}
Treinamentos
Listar Treinamentos
Recuperar uma lista de dados de treinamento para um agente específico
GET
/
api
/
v1
/
agents
/
{agent_id}
/
trainings
# Requisição 1: Obter todos os treinamentos de um agente
curl -X GET "https://app.talkover.ai/api/v1/agents/agent-uuid-1/trainings" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Requisição 1: Obter todos os treinamentos de um agente
const response = await fetch('https://app.talkover.ai/api/v1/agents/agent-uuid-1/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",
"question": "Como posso ajudar com informações sobre produtos?",
"answer": "Posso fornecer informações detalhadas sobre nossos produtos, incluindo especificações, preços e disponibilidade. Qual produto você gostaria de conhecer?",
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
},
{
"id": "training-uuid-2",
"question": "Qual é o processo de suporte técnico?",
"answer": "Para suporte técnico, posso ajudá-lo a identificar o problema e orientá-lo sobre os próximos passos. Posso também agendar um técnico se necessário.",
"created_at": "2024-01-01T01:00:00Z",
"updated_at": "2024-01-01T01:00:00Z"
}
],
"pagination": {
"current_page": 1,
"last_page": 3,
"per_page": 20,
"total": 50,
"from": 1,
"to": 20
}
}
Listar Treinamentos
Recuperar uma lista de dados de treinamento para um agente específico com suporte à paginação.Endpoint
GET /api/v1/agents/{agent_id}/trainings
Parâmetros de caminho
string
obrigatório
O identificador único do agente. Você pode encontrá-lo na lista de agentes.
Cabeçalhos da requisição
string
obrigatório
Token Bearer para autenticação. Formato:
Bearer talq_your_environment_token_hereParâmetros de consulta
integer
Número de itens por página (padrão: 20, máximo: 100)
integer
Número da página (padrão: 1)
Exemplos de Requisição
# Requisição 1: Obter todos os treinamentos de um agente
curl -X GET "https://app.talkover.ai/api/v1/agents/agent-uuid-1/trainings" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Requisição 1: Obter todos os treinamentos de um agente
const response = await fetch('https://app.talkover.ai/api/v1/agents/agent-uuid-1/trainings', {
method: 'GET',
headers: {
'Authorization': 'Bearer talq_your_environment_token_here'
}
});
const result = await response.json();
console.log(result);
# Requisição 2: Obter treinamentos com paginação
curl -X GET "https://app.talkover.ai/api/v1/agents/agent-uuid-1/trainings?per_page=50&page=1" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Requisição 2: Obter treinamentos com paginação
const response = await fetch('https://app.talkover.ai/api/v1/agents/agent-uuid-1/trainings?per_page=50&page=1', {
method: 'GET',
headers: {
'Authorization': 'Bearer talq_your_environment_token_here'
}
});
const result = await response.json();
console.log(result);
Resposta
Resposta de Sucesso (200 OK)
{
"success": true,
"data": [
{
"id": "training-uuid-1",
"question": "Como posso ajudar com informações sobre produtos?",
"answer": "Posso fornecer informações detalhadas sobre nossos produtos, incluindo especificações, preços e disponibilidade. Qual produto você gostaria de conhecer?",
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
},
{
"id": "training-uuid-2",
"question": "Qual é o processo de suporte técnico?",
"answer": "Para suporte técnico, posso ajudá-lo a identificar o problema e orientá-lo sobre os próximos passos. Posso também agendar um técnico se necessário.",
"created_at": "2024-01-01T01:00:00Z",
"updated_at": "2024-01-01T01:00:00Z"
}
],
"pagination": {
"current_page": 1,
"last_page": 3,
"per_page": 20,
"total": 50,
"from": 1,
"to": 20
}
}
Campos da Resposta
boolean
obrigatório
Indica se a operação foi bem-sucedida.
array
obrigatório
Array de objetos de treinamento.
Mostrar Objeto de Treinamento
Mostrar Objeto de Treinamento
object
obrigatório
Metadados de paginação.
Mostrar Objeto de Paginação
Mostrar Objeto de Paginação
Respostas de erro
404 Não Encontrado
{
"success": false,
"message": "Agent not found"
}
401 Não Autorizado
{
"success": false,
"message": "Unauthorized"
}
500 Erro do Servidor
{
"success": false,
"message": "Internal server error."
}
Códigos de erro
| Código | Descrição | Status HTTP |
|---|---|---|
AGENT_NOT_FOUND | Agente especificado não existe | 404 |
INVALID_TOKEN | Token de autenticação inválido ou ausente | 401 |
SERVER_ERROR | Erro interno do servidor ocorreu | 500 |
Notas Importantes
Suporte à paginação. Use parâmetros
page e per_page para navegar pelos resultados.Dados de treinamento. Os dados de treinamento ajudam a melhorar o desempenho do agente.
Perguntas e respostas. Cada treinamento contém uma pergunta e sua resposta correspondente.
Melhores Práticas
- Use paginação - Sempre use paginação para grandes conjuntos de dados de treinamento
- Mantenha dados atualizados - Regularmente atualize os dados de treinamento para melhorar o desempenho
- Qualidade das perguntas - Use perguntas claras e específicas para melhor treinamento
- Respostas detalhadas - Forneça respostas completas e úteis
- Monitore desempenho - Acompanhe como os dados de treinamento afetam o desempenho do agente
Endpoints relacionados
- Criar/Atualizar Treinamento:
POST /api/v1/agents/{agent_id}/trainings - Excluir Treinamento:
DELETE /api/v1/agents/{agent_id}/trainings/{training_id} - Obter Agente:
GET /api/v1/agents/{agent_id} - Listar Agentes:
GET /api/v1/agents
Esta página foi útil?