エージェントを一覧表示

エージェントとそのメタデータのリストを返します。

ヘッダー

xi-api-keystringオプション

クエリパラメータ

page_sizeintegerオプション1-100デフォルト値 30

返すエージェントの最大数です。100を超えることはできず、デフォルトは30です。

searchstring or nullオプション

エージェント名で検索します。

archivedboolean or nullオプションデフォルト値 false

アーカイブ状態でエージェントをフィルター

show_only_owned_agentsbooleanオプションデフォルト値 falseDeprecated

trueに設定すると、エンドポイントは他者から共有されたエージェントを除外し、自分が所有するエージェントのみを含めます。非推奨:代わりにcreated_by_user_idを使用してください。

created_by_user_idstring or nullオプション

作成者ユーザーIDでエージェントをフィルターします。設定すると、このユーザーが作成したエージェントのみが返されます。show_only_owned_agentsより優先されます。認証済みユーザーを指定するには’@me’を使用します。

tagslist of strings or nullオプション

タグでエージェントをフィルターします。複数のタグのいずれかに一致させるには、パラメータを繰り返し指定します。

sort_directionenumオプション

結果の並べ替え方向

許可された値:
sort_byenum or nullオプション

結果の並べ替えに使用するフィールド

許可された値:
cursorstring or nullオプション

次のページを取得するために使用します。カーソルはレスポンスで返されます。

レスポンス

成功レスポンス。

agentslist of objects

エージェントとそのメタデータのリストです。

has_moreboolean

ページネーションで取得できるエージェントがさらにあるかどうか

next_cursorstring or nullオプション

エージェントをページネーションするための次のカーソル。

エラー

422
Unprocessable Entity Error