Skip to main content
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_here

Parâmetros de consulta

string
Filtrar por status do agente. Opções: draft, published, unpublished
string
Filtrar por idioma do agente (ex: en-US, pt-BR)
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

  1. Use paginação - Sempre use paginação para grandes conjuntos de dados
  2. Filtre por status - Use filtros de status para encontrar agentes publicados ou em rascunho
  3. Pesquise eficientemente - Use o parâmetro de pesquisa para encontrar agentes específicos rapidamente
  4. Monitore status - Filtre por status para acompanhar o progresso dos agentes
  5. 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}