Pular para o conteúdo principal
POST
/
api
/
v1
/
agents
/
{agent_id}
/
trainings
# Requisição 1: Criar novo treinamento
curl -X POST "https://app.talkover.ai/api/v1/agents/agent-uuid-1/trainings" \
  -H "Authorization: Bearer talq_your_environment_token_here" \
  -H "Content-Type: application/json" \
  -d '{
    "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?"
  }'
{
  "success": true,
  "message": "Treinamento criado com sucesso",
  "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"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.talkover.ai/llms.txt

Use this file to discover all available pages before exploring further.

Criar/Atualizar Treinamento

Criar ou atualizar dados de treinamento para um agente específico. Este endpoint permite adicionar perguntas e respostas para melhorar o desempenho do agente.

Endpoint

POST /api/v1/agents/{agent_id}/trainings

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
Content-Type
string
obrigatório
Application JSON. Formato: application/json

Corpo da Requisição

question
string
obrigatório
Pergunta para o treinamento (máximo 1000 caracteres).
answer
string
obrigatório
Resposta para o treinamento (máximo 2000 caracteres).

Exemplos de Requisição

# Requisição 1: Criar novo treinamento
curl -X POST "https://app.talkover.ai/api/v1/agents/agent-uuid-1/trainings" \
  -H "Authorization: Bearer talq_your_environment_token_here" \
  -H "Content-Type: application/json" \
  -d '{
    "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?"
  }'
# Requisição 2: Criar treinamento para suporte técnico
curl -X POST "https://app.talkover.ai/api/v1/agents/agent-uuid-1/trainings" \
  -H "Authorization: Bearer talq_your_environment_token_here" \
  -H "Content-Type: application/json" \
  -d '{
    "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. Qual é o problema que você está enfrentando?"
  }'

Resposta

Resposta de Sucesso (201 Created)

{
  "success": true,
  "message": "Treinamento criado com sucesso",
  "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"
  }
}

Campos da Resposta

success
boolean
obrigatório
Indica se a operação foi bem-sucedida.
message
string
obrigatório
Mensagem de sucesso descrevendo a operação.
data
object
obrigatório
Dados do treinamento criado.

Respostas de Erro

404 Não Encontrado

{
  "success": false,
  "message": "Agent not found"
}

422 Erro de Validação

{
  "success": false,
  "message": "The given data was invalid.",
  "errors": {
    "question": [
      "The question field is required."
    ],
    "answer": [
      "The answer field is required."
    ],
    "question": [
      "The question may not be greater than 1000 characters."
    ],
    "answer": [
      "The answer may not be greater than 2000 characters."
    ]
  }
}

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
VALIDATION_ERRORValidação da requisição falhou422
INVALID_TOKENToken de autenticação inválido ou ausente401
SERVER_ERRORErro interno do servidor ocorreu500

Notas Importantes

Limites de caracteres. Perguntas têm limite de 1000 caracteres e respostas de 2000 caracteres.
Melhoria de desempenho. Dados de treinamento ajudam a melhorar o desempenho do agente.
Perguntas claras. Use perguntas claras e específicas para melhor treinamento.
Respostas úteis. Forneça respostas completas e úteis para melhor experiência do usuário.

Melhores Práticas

  1. Perguntas específicas - Use perguntas claras e específicas para melhor treinamento
  2. Respostas detalhadas - Forneça respostas completas e úteis
  3. Variedade de cenários - Crie treinamentos para diferentes cenários de uso
  4. Atualização regular - Regularmente atualize os dados de treinamento
  5. Teste o desempenho - Monitore como os treinamentos afetam o desempenho do agente

Endpoints Relacionados

  • Listar Treinamentos: GET /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