# Requisição 1: Obter detalhes de um agente específico
curl -X GET "https://app.talkover.ai/api/v1/agents/agent-uuid-1" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Requisição 1: Obter detalhes de um agente específico
const response = await fetch('https://app.talkover.ai/api/v1/agents/agent-uuid-1', {
method: 'GET',
headers: {
'Authorization': 'Bearer talq_your_environment_token_here'
}
});
const result = await response.json();
console.log(result);
{
"success": true,
"data": {
"id": "agent-uuid-1",
"name": "Agente de Atendimento",
"description": "Agente especializado em atendimento ao cliente",
"status": "published",
"language": "pt-BR",
"voice_template_id": "voice-template-uuid-1",
"voice_template_name": "Bianca",
"knowledge_base": "Este é um agente de atendimento ao cliente especializado em resolver dúvidas e problemas dos clientes. Ele pode ajudar com informações sobre produtos, serviços, preços e suporte técnico.",
"interrupt_sensitivity": "medium",
"who_speaks_first": "agent",
"initial_message": "Olá! Sou o agente de atendimento. Como posso ajudá-lo hoje?",
"conversation_starters": [
"Gostaria de informações sobre nossos produtos?",
"Posso ajudá-lo com alguma dúvida?",
"Precisa de suporte técnico?"
],
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
}
}
Agentes
Obter Agente
Recuperar detalhes de um agente específico por ID
GET
/
api
/
v1
/
agents
/
{agent_id}
# Requisição 1: Obter detalhes de um agente específico
curl -X GET "https://app.talkover.ai/api/v1/agents/agent-uuid-1" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Requisição 1: Obter detalhes de um agente específico
const response = await fetch('https://app.talkover.ai/api/v1/agents/agent-uuid-1', {
method: 'GET',
headers: {
'Authorization': 'Bearer talq_your_environment_token_here'
}
});
const result = await response.json();
console.log(result);
{
"success": true,
"data": {
"id": "agent-uuid-1",
"name": "Agente de Atendimento",
"description": "Agente especializado em atendimento ao cliente",
"status": "published",
"language": "pt-BR",
"voice_template_id": "voice-template-uuid-1",
"voice_template_name": "Bianca",
"knowledge_base": "Este é um agente de atendimento ao cliente especializado em resolver dúvidas e problemas dos clientes. Ele pode ajudar com informações sobre produtos, serviços, preços e suporte técnico.",
"interrupt_sensitivity": "medium",
"who_speaks_first": "agent",
"initial_message": "Olá! Sou o agente de atendimento. Como posso ajudá-lo hoje?",
"conversation_starters": [
"Gostaria de informações sobre nossos produtos?",
"Posso ajudá-lo com alguma dúvida?",
"Precisa de suporte técnico?"
],
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
}
}
Obter Agente
Recuperar detalhes completos de um agente específico, incluindo configurações, base de conhecimento e status atual.Endpoint
GET /api/v1/agents/{agent_id}
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_hereExemplos de Requisição
# Requisição 1: Obter detalhes de um agente específico
curl -X GET "https://app.talkover.ai/api/v1/agents/agent-uuid-1" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Requisição 1: Obter detalhes de um agente específico
const response = await fetch('https://app.talkover.ai/api/v1/agents/agent-uuid-1', {
method: 'GET',
headers: {
'Authorization': 'Bearer talq_your_environment_token_here'
}
});
const result = await response.json();
console.log(result);
# Requisição 2: Obter agente com ID específico
curl -X GET "https://app.talkover.ai/api/v1/agents/550e8400-e29b-41d4-a716-446655440000" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Requisição 2: Obter agente com ID específico
const agent_id = '550e8400-e29b-41d4-a716-446655440000';
const response = await fetch(`https://app.talkover.ai/api/v1/agents/${agent_id}`, {
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": "agent-uuid-1",
"name": "Agente de Atendimento",
"description": "Agente especializado em atendimento ao cliente",
"status": "published",
"language": "pt-BR",
"voice_template_id": "voice-template-uuid-1",
"voice_template_name": "Bianca",
"knowledge_base": "Este é um agente de atendimento ao cliente especializado em resolver dúvidas e problemas dos clientes. Ele pode ajudar com informações sobre produtos, serviços, preços e suporte técnico.",
"interrupt_sensitivity": "medium",
"who_speaks_first": "agent",
"initial_message": "Olá! Sou o agente de atendimento. Como posso ajudá-lo hoje?",
"conversation_starters": [
"Gostaria de informações sobre nossos produtos?",
"Posso ajudá-lo com alguma dúvida?",
"Precisa de suporte técnico?"
],
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
}
}
Campos da Resposta
boolean
obrigatório
Indica se a operação foi bem-sucedida.
object
obrigatório
Dados completos do agente.
Mostrar Objeto de Agente
Mostrar Objeto de Agente
string
obrigatório
Identificador único do agente.
string
obrigatório
Nome do agente.
string
Descrição do agente.
string
obrigatório
Status atual do agente. Opções:
draft, published, unpublished.string
obrigatório
Idioma do agente (ex:
pt-BR, en-US).string
obrigatório
ID do modelo de voz associado ao agente.
string
obrigatório
Nome do modelo de voz associado ao agente.
string
obrigatório
Base de conhecimento completa do agente.
string
obrigatório
Sensibilidade à interrupção. Opções:
low, medium, high.string
obrigatório
Quem fala primeiro. Opções:
agent, human.string
Mensagem inicial do agente.
array
Array de iniciadores de conversa para o agente.
string
obrigatório
Timestamp ISO 8601 quando o agente foi criado.
string
obrigatório
Timestamp ISO 8601 quando o agente foi atualizado pela última vez.
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
Dados completos. Este endpoint retorna todos os detalhes do agente, incluindo configurações completas.
Base de conhecimento. A base de conhecimento completa é retornada para análise e edição.
Configurações de comportamento. Inclui todas as configurações de comportamento do agente.
Melhores Práticas
- Use para edição - Use este endpoint para obter dados completos antes de editar um agente
- Verifique status - Confirme o status do agente antes de fazer alterações
- Analise configurações - Revise todas as configurações antes de publicar
- Monitore atualizações - Use
updated_atpara acompanhar mudanças - Trate erros - Implemente tratamento adequado de erros para agentes não encontrados
Endpoints relacionados
- Listar Agentes:
GET /api/v1/agents - Criar Agente:
POST /api/v1/agents - Atualizar Conhecimento do Agente:
PUT /api/v1/agents/{agent_id}/knowledge - Atualizar Voz do Agente:
PUT /api/v1/agents/{agent_id}/voice - Excluir Agente:
DELETE /api/v1/agents/{agent_id}
Esta página foi útil?