エージェントの取得

Box AI Studioは、Enterprise Advancedアカウントでのみ使用できます。

GET /2.0/ai_agentsエンドポイントを使用すると、指定されたパラメータに基づいてすべてのAIエージェントのリストを取得できます。

リクエストを送信するには、GET /2.0/ai_agentsエンドポイントを使用します。

アプリを承認するための開発者トークンを生成済みであることを確認します。詳細については、Box AI Studioの使い方を参照してください。

curl -i -X GET "https://api.box.com/2.0/ai_agents" \
     -H "authorization: Bearer <ACCESS_TOKEN>"

await client.aiStudio.getAiAgents();

client.ai_studio.get_ai_agents()

await client.AiStudio.GetAiAgentsAsync();

コールを実行するには、以下のパラメータを渡す必要があります。必須のパラメータは太字で示されています。

パラメータ	説明	例
`mode`	返されるエージェント構成にフィルタをかけるためのモード。使用可能な値は`ask`、`text_gen`、`extract`です。	`ask`
`fields`	レスポンスで返されるフィールド。	`ask`
`agent_state`	返されるエージェントの状態。値は`enabled`、`disabled`のいずれかです。	`enabled`
`fields`	レスポンスで返されるフィールド。値は`ask`、`text_gen`、`extract`のいずれかです。	`ask`
`include_box_default`	レスポンスにBoxのデフォルトエージェントを含めるかどうか。	`true`
`limit`	返す項目の1ページあたりの最大数。	`1000`
`marker`	結果が返される開始位置のマーカー。	`JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii`

すべてのAIエージェントのリストの取得