Lister les agents

Renvoie la liste de vos agents et de leurs métadonnées.

En-têtes

xi-api-keystringOptionnel

Paramètres de requête

page_sizeintegerOptionnel1-100Par défaut 30

Nombre maximal d’agents à renvoyer. Ne peut pas dépasser 100 ; 30 par défaut.

searchstring or nullOptionnel

Rechercher par nom d’agent.

archivedboolean or nullOptionnelPar défaut false
Filtrer les agents par statut d'archivage
show_only_owned_agentsbooleanOptionnelPar défaut falseDeprecated

Si défini sur true, le point de terminaison omettra les agents qu’une autre personne a partagés avec vous et inclura uniquement ceux qui vous appartiennent. Obsolète : utilisez created_by_user_id à la place.

created_by_user_idstring or nullOptionnel

Filtre les agents par ID de l’utilisateur créateur. Lorsqu’il est défini, seuls les agents créés par cet utilisateur sont renvoyés. Prévaut sur show_only_owned_agents. Utilisez ‘@me’ pour désigner l’utilisateur authentifié.

tagslist of strings or nullOptionnel

Filtre les agents par étiquette. Répétez le paramètre pour correspondre à l’une de plusieurs étiquettes.

sort_directionenumOptionnel

L’ordre de tri des résultats

Valeurs autorisées:
sort_byenum or nullOptionnel

Le champ selon lequel trier les résultats

Valeurs autorisées:
cursorstring or nullOptionnel

Utilisé pour récupérer la page suivante. Le curseur est renvoyé dans la réponse.

Réponse

Réponse réussie

agentslist of objects

Liste des agents et de leurs métadonnées.

has_moreboolean

Indique s’il y a d’autres agents à paginer

next_cursorstring or nullOptionnel
Le curseur suivant pour paginer les agents

Erreurs

422
Unprocessable Entity Error