# Requisição 1: Obter todos os agentes
curl -X GET "https://app.talkover.ai/api/v1/agents" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Requisição 1: Obter todos os agentes
const response = await fetch('https://app.talkover.ai/api/v1/agents', {
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": "Base de conhecimento para atendimento",
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
},
{
"id": "agent-uuid-2",
"name": "Agente de Vendas",
"description": "Agente especializado em vendas e prospecção",
"status": "draft",
"language": "pt-BR",
"voice_template_id": "voice-template-uuid-2",
"voice_template_name": "Isabela",
"knowledge_base": "Base de conhecimento para vendas",
"created_at": "2024-01-01T01:00:00Z",
"updated_at": "2024-01-01T01:00:00Z"
}
],
"pagination": {
"current_page": 1,
"last_page": 5,
"per_page": 20,
"total": 100,
"from": 1,
"to": 20
}
}
Agentes
Listar Agentes
Recuperar uma lista de agentes de voz com opções de filtragem e paginação
GET
/
api
/
v1
/
agents
# Requisição 1: Obter todos os agentes
curl -X GET "https://app.talkover.ai/api/v1/agents" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Requisição 1: Obter todos os agentes
const response = await fetch('https://app.talkover.ai/api/v1/agents', {
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": "Base de conhecimento para atendimento",
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
},
{
"id": "agent-uuid-2",
"name": "Agente de Vendas",
"description": "Agente especializado em vendas e prospecção",
"status": "draft",
"language": "pt-BR",
"voice_template_id": "voice-template-uuid-2",
"voice_template_name": "Isabela",
"knowledge_base": "Base de conhecimento para vendas",
"created_at": "2024-01-01T01:00:00Z",
"updated_at": "2024-01-01T01:00:00Z"
}
],
"pagination": {
"current_page": 1,
"last_page": 5,
"per_page": 20,
"total": 100,
"from": 1,
"to": 20
}
}
Listar Agentes
Recuperar uma lista de agentes de voz para o ambiente autenticado com várias opções de filtragem e suporte à paginação.Endpoint
GET /api/v1/agents
Cabeçalhos da requisição
string
obrigatório
Token Bearer para autenticação. Formato:
Bearer talq_your_environment_token_hereParâmetros de consulta
string
Filtrar por status do agente. Opções:
draft, published, unpublishedstring
Filtrar por idioma do agente (ex:
en-US, pt-BR)string
Pesquisar no nome ou descrição do agente
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 agentes
curl -X GET "https://app.talkover.ai/api/v1/agents" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Requisição 1: Obter todos os agentes
const response = await fetch('https://app.talkover.ai/api/v1/agents', {
method: 'GET',
headers: {
'Authorization': 'Bearer talq_your_environment_token_here'
}
});
const result = await response.json();
console.log(result);
# Requisição 2: Obter agentes publicados em português
curl -X GET "https://app.talkover.ai/api/v1/agents?status=published&language=pt-BR&per_page=50" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Requisição 2: Obter agentes publicados em português
const response = await fetch('https://app.talkover.ai/api/v1/agents?status=published&language=pt-BR&per_page=50', {
method: 'GET',
headers: {
'Authorization': 'Bearer talq_your_environment_token_here'
}
});
const result = await response.json();
console.log(result);
# Requisição 3: Pesquisar por nome específico
curl -X GET "https://app.talkover.ai/api/v1/agents?search=Atendimento" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Requisição 3: Pesquisar por nome específico
const response = await fetch('https://app.talkover.ai/api/v1/agents?search=Atendimento', {
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": "Base de conhecimento para atendimento",
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
},
{
"id": "agent-uuid-2",
"name": "Agente de Vendas",
"description": "Agente especializado em vendas e prospecção",
"status": "draft",
"language": "pt-BR",
"voice_template_id": "voice-template-uuid-2",
"voice_template_name": "Isabela",
"knowledge_base": "Base de conhecimento para vendas",
"created_at": "2024-01-01T01:00:00Z",
"updated_at": "2024-01-01T01:00:00Z"
}
],
"pagination": {
"current_page": 1,
"last_page": 5,
"per_page": 20,
"total": 100,
"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 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 do 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.
object
obrigatório
Metadados de paginação.
Mostrar Objeto de Paginação
Mostrar Objeto de Paginação
Respostas de erro
401 Não Autorizado
{
"success": false,
"message": "Unauthorized"
}
422 Erro de Validação
{
"success": false,
"message": "The given data was invalid.",
"errors": {
"status": [
"The selected status is invalid."
],
"language": [
"The selected language is invalid."
]
}
}
500 Erro do Servidor
{
"success": false,
"message": "Internal server error."
}
Códigos de erro
| Código | Descrição | Status HTTP |
|---|---|---|
INVALID_TOKEN | Token de autenticação inválido ou ausente | 401 |
VALIDATION_ERROR | Validação dos parâmetros de consulta falhou | 422 |
SERVER_ERROR | Erro interno do servidor ocorreu | 500 |
Notas Importantes
Suporte à paginação. Todos os endpoints de lista suportam paginação com parâmetros
page e per_page.Filtros disponíveis. Use parâmetros de consulta para filtrar agentes por status, idioma e pesquisa.
Funcionalidade de pesquisa. O parâmetro de pesquisa busca no nome e descrição dos agentes.
Melhores Práticas
- Use paginação - Sempre use paginação para grandes conjuntos de dados
- Filtre por status - Use filtros de status para encontrar agentes publicados ou em rascunho
- Pesquise eficientemente - Use o parâmetro de pesquisa para encontrar agentes específicos rapidamente
- Monitore status - Filtre por status para acompanhar o progresso dos agentes
- Trate erros - Implemente tratamento adequado de erros para falhas de autenticação e validação
Endpoints relacionados
- Criar Agente:
POST /api/v1/agents - Obter Agente:
GET /api/v1/agents/{agent_id} - Atualizar Conhecimento do Agente:
PUT /api/v1/agents/{agent_id}/knowledge - Excluir Agente:
DELETE /api/v1/agents/{agent_id}
Esta página foi útil?