Pular para o conteúdo principal
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"

{
  "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

​
agent
string
obrigatório
O identificador único do agente. Você pode encontrá-lo na lista de agentes.

​
Cabeçalhos da requisição

​
Authorization
string
obrigatório
Token Bearer para autenticação. Formato: Bearer talq_your_environment_token_here

​
Exemplos 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 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"

​
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

​
success
boolean
obrigatório
Indica se a operação foi bem-sucedida.
​
data
object
obrigatório
Dados completos do agente.

​
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ódigoDescriçãoStatus HTTP
AGENT_NOT_FOUNDAgente especificado não existe404
INVALID_TOKENToken de autenticação inválido ou ausente401
SERVER_ERRORErro interno do servidor ocorreu500

​
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

  1. Use para edição - Use este endpoint para obter dados completos antes de editar um agente
  2. Verifique status - Confirme o status do agente antes de fazer alterações
  3. Analise configurações - Revise todas as configurações antes de publicar
  4. Monitore atualizações - Use updated_at para acompanhar mudanças
  5. 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}