ElevenAgentsAgents

Listar agentes

Devuelve una lista de tus agentes y sus metadatos.

Encabezados

xi-api-keystringOpcional

Parámetros de consulta

page_sizeintegerOpcional1-100Valor predeterminado: 30

Número máximo de agentes que se devolverán. No puede superar 100; el valor predeterminado es 30.

searchstring or nullOpcional
Busca por nombre de agente.
archivedboolean or nullOpcionalValor predeterminado: false
Filtra agentes por estado de archivado
show_only_owned_agentsbooleanOpcionalValor predeterminado: falseDeprecated

Si se establece en true, la ruta de API omitirá los agentes que otra persona haya compartido contigo e incluirá solo los que te pertenecen. Obsoleto: usa created_by_user_id en su lugar.

created_by_user_idstring or nullOpcional

Filtra agentes por ID de usuario creador. Cuando se establece, solo se devuelven los agentes creados por este usuario. Tiene prioridad sobre show_only_owned_agents. Utiliza ‘@me’ para hacer referencia al usuario autenticado.

tagslist of strings or nullOpcional

Filtra agentes por etiqueta. Repite el parámetro para que coincida con cualquiera de varias etiquetas.

sort_directionenumOpcional

La dirección para ordenar los resultados

Valores permitidos:
sort_byenum or nullOpcional

El campo por el que se ordenarán los resultados

Valores permitidos:
cursorstring or nullOpcional

Se usa para obtener la página siguiente. El cursor se devuelve en la respuesta.

Respuesta

Respuesta correcta.
agentslist of objects
Una lista de agentes y sus metadatos.
has_moreboolean

Indica si hay más agentes que paginar

next_cursorstring or nullOpcional
El siguiente cursor para paginar los agentes

Errores

422
Unprocessable Entity Error