Listar agentes

Retorna uma lista dos seus agentes e metadados.

Cabeçalhos

xi-api-keystringOpcional

Parâmetros de consulta

page_sizeintegerOpcional1-100Padrão é 30

Quantidade máxima de agentes a retornar. Não pode exceder 100; o padrão é 30.

searchstring or nullOpcional
Pesquise pelo nome dos agentes.
archivedboolean or nullOpcionalPadrão é false
Filtrar agentes por status de arquivamento
show_only_owned_agentsbooleanOpcionalPadrão é falseDeprecated

Se definido como true, o endpoint omitirá agentes compartilhados com você por outras pessoas e incluirá apenas os que pertencem a você. Obsoleto: use created_by_user_id.

created_by_user_idstring or nullOpcional

Filtre agentes pelo ID do usuário criador. Quando definido, retorna apenas os agentes criados por este usuário. Tem precedência sobre show_only_owned_agents. Use ‘@me’ para se referir ao usuário autenticado.

tagslist of strings or nullOpcional

Filtre agentes por tag. Repita o parâmetro para corresponder a qualquer uma de várias tags.

sort_directionenumOpcional

A direção para ordenar os resultados

Valores permitidos:
sort_byenum or nullOpcional
O campo pelo qual ordenar os resultados
Valores permitidos:
cursorstring or nullOpcional

Usado para buscar a próxima página. O cursor é retornado na resposta.

Resposta

Resposta bem-sucedida

agentslist of objects
Uma lista de agentes e seus metadados.
has_moreboolean

Indica se há mais agentes para paginar

next_cursorstring or nullOpcional

O próximo cursor para paginar os agentes

Erros

422
Unprocessable Entity Error