Agentes
Listar Agentes
Recuperar uma lista de agentes de voz com opções de filtragem e paginação
GET
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
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
Resposta
Resposta de Sucesso (200 OK)
Campos da Resposta
boolean
obrigatório
Indica se a operação foi bem-sucedida.
array
obrigatório
Array de objetos de agente.
object
obrigatório
Metadados de paginação.
Respostas de erro
401 Não Autorizado
422 Erro de Validação
500 Erro do Servidor
Códigos de erro
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}