メインコンテンツへスキップ
POST
cURL
このリソースは、バージョン2024.0のエンドポイントで使用されています。 詳細については、 Box APIのバージョン管理を参照してください。Box SDKのバージョニング戦略について詳しく学ぶ。」

承認

Authorization
string
header
必須

The access token received from the authorization server in the OAuth 2.0 flow.

ボディ

application/json

AIエージェント作成リクエストのスキーマ。

type
enum<string>
必須

クエリの処理に使用されるエージェントのタイプ。

利用可能なオプション:
ai_agent
:

"ai_agent"

name
string
必須

AIエージェントの名前。

:

"My AI Agent"

access_state
string
必須

AIエージェントの状態。使用可能な値はenableddisabledenabled_for_selected_usersです。

:

"enabled"

icon_reference
string

AIエージェントのアイコン参照。これは、URL https://cdn01.boxcdn.net/app-assets/aistudio/avatars/<file_name>の形式で指定する必要があります。この場合、file_nameに使用可能な値はlogo_boxAi.pnglogo_stamp.pnglogo_legal.pnglogo_finance.pnglogo_config.pnglogo_handshake.pnglogo_analytics.pnglogo_classification.pngです。

Minimum string length: 1
:

"https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg"

allowed_entities
(ユーザー (Base) · object | グループ (Base) · object)[]

許可するユーザーまたはグループのリスト。

他のリソース内にネストされたときに使用されるユーザーのMini版の表示。

ask
AIエージェントの機能 (質問リクエスト) · object

クエリの処理に使用するAIエージェント。

text_gen
AIエージェントの機能 (テキスト生成リクエスト) · object

テキストの生成に使用するAIエージェント。

extract
AIエージェントの機能 (抽出リクエスト) · object

メタデータ抽出に使用するAIエージェント。

レスポンス

作成されたAIエージェントの定義。

AIエージェントインスタンスのFull版の表示。

id
string
必須

AIエージェントの一意の識別子。

:

"1234567890"

origin
string
必須

AIエージェントのプロバイダ。

:

"CUSTOM"

name
string
必須

AIエージェントの名前。

:

"This is my Agent"

access_state
string
必須

AIエージェントの状態。使用可能な値はenableddisabledenabled_for_selected_usersです。

:

"enabled"

type
enum<string>

クエリの処理に使用されるエージェントのタイプ。

利用可能なオプション:
ai_agent
:

"ai_agent"

created_by
ユーザー (Base) · object

このエージェントを作成したユーザー。

created_at
string<date-time>

このAIエージェントが作成された時点のISO日時形式のタイムスタンプ。

:

"2022-01-01T00:00:00Z"

modified_by
ユーザー (Base) · object

このエージェントを直近で変更したユーザー。

modified_at
string<date-time>

このAIエージェントが最近変更された時点のISO日時形式のタイムスタンプ。

:

"2022-01-01T00:00:00Z"

icon_reference
string

AIエージェントのアイコン参照。

Minimum string length: 1
:

"https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg"

allowed_entities
(ユーザー (Base) · object | グループ (Base) · object)[]

許可するユーザーまたはグループのリスト。

他のリソース内にネストされたときに使用されるユーザーのMini版の表示。

ask
AIエージェントの機能 (質問) · object

質問に使用するAIエージェント。

text_gen
AIエージェントの機能 (テキスト生成) · object

テキストの生成に使用するAIエージェント。

extract
AIエージェントの機能 (抽出) · object

メタデータ抽出に使用するAIエージェント。

最終更新日 2026年1月23日