cURL
curl -i -X PUT "https://api.box.com/2.0/ai_agents/1234567890" \
-H "authorization: Bearer <ACCESS_TOKEN>"client.ai_studio.update_ai_agent_by_id(
created_agent.id,
agent_name,
"enabled",
ask=AiStudioAgentAsk(access_state="disabled", description="desc2"),
)await client.aiStudio.updateAiAgentById(createdAgent.id, {
name: agentName,
accessState: 'enabled',
ask: new AiStudioAgentAsk({ accessState: 'disabled', description: 'desc2' }),
} satisfies CreateAiAgentInput);try await client.aiStudio.updateAiAgentById(agentId: createdAgent.id, requestBody: CreateAiAgent(name: agentName, accessState: "enabled", ask: AiStudioAgentAsk(accessState: "disabled", description: "desc2")))client.getAiStudio().updateAiAgentById(createdAgent.getId(), new CreateAiAgent.Builder(agentName, "enabled").ask(new AiStudioAgentAsk("disabled", "desc2")).build())await client.AiStudio.UpdateAiAgentByIdAsync(agentId: createdAgent.Id, requestBody: new CreateAiAgent(name: agentName, accessState: "enabled") { Ask = new AiStudioAgentAsk(accessState: "disabled", description: "desc2") });{
"id": "1234567890",
"origin": "CUSTOM",
"name": "This is my Agent",
"access_state": "enabled",
"type": "ai_agent",
"created_by": {
"id": "11446498",
"type": "user"
},
"created_at": "2022-01-01T00:00:00Z",
"modified_by": {
"id": "11446498",
"type": "user"
},
"modified_at": "2022-01-01T00:00:00Z",
"icon_reference": "https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg",
"allowed_entities": [
{
"id": "11446498",
"type": "user"
}
],
"ask": {
"type": "ai_agent_ask",
"access_state": "enabled",
"description": "This is ASK Agent",
"custom_instructions": "This is a custom instruction",
"suggested_questions": [
"What is in this file?",
"What are the main highlights of this document?"
],
"long_text": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"embeddings": {
"model": "azure__openai__text_embedding_ada_002",
"strategy": {
"id": "basic",
"num_tokens_per_chunk": 64
}
},
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_text": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_image": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
},
"spreadsheet": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"warnings": [
"MODEL_INACTIVE"
]
},
"long_text_multi": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"embeddings": {
"model": "azure__openai__text_embedding_ada_002",
"strategy": {
"id": "basic",
"num_tokens_per_chunk": 64
}
},
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_text_multi": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_image_multi": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
}
},
"text_gen": {
"type": "ai_agent_text_gen",
"access_state": "enabled",
"description": "This is ASK Agent",
"custom_instructions": "This is a custom instruction",
"suggested_questions": [
"What is in this file?",
"What are the main highlights of this document?"
],
"basic_gen": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, and I have $8000 and want to spend a week in the Azores. `{user_question}`",
"embeddings": {
"model": "azure__openai__text_embedding_ada_002",
"strategy": {
"id": "basic",
"num_tokens_per_chunk": 64
}
},
"content_template": "---{content}---",
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
}
},
"extract": {
"type": "ai_agent_extract",
"access_state": "enabled",
"description": "This is ASK Agent",
"custom_instructions": "This is a custom instruction",
"long_text": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"embeddings": {
"model": "azure__openai__text_embedding_ada_002",
"strategy": {
"id": "basic",
"num_tokens_per_chunk": 64
}
},
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_text": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_image": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
}
}
}{
"type": "error",
"status": 400,
"code": "item_name_invalid",
"message": "Method Not Allowed",
"context_info": {
"message": "Something went wrong"
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"request_id": "abcdef123456"
}{
"type": "error",
"status": 400,
"code": "item_name_invalid",
"message": "Method Not Allowed",
"context_info": {
"message": "Something went wrong"
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"request_id": "abcdef123456"
}AI Studio
AIエージェントを更新
AIエージェントを更新します。
PUT
/
ai_agents
/
{agent_id}
cURL
curl -i -X PUT "https://api.box.com/2.0/ai_agents/1234567890" \
-H "authorization: Bearer <ACCESS_TOKEN>"client.ai_studio.update_ai_agent_by_id(
created_agent.id,
agent_name,
"enabled",
ask=AiStudioAgentAsk(access_state="disabled", description="desc2"),
)await client.aiStudio.updateAiAgentById(createdAgent.id, {
name: agentName,
accessState: 'enabled',
ask: new AiStudioAgentAsk({ accessState: 'disabled', description: 'desc2' }),
} satisfies CreateAiAgentInput);try await client.aiStudio.updateAiAgentById(agentId: createdAgent.id, requestBody: CreateAiAgent(name: agentName, accessState: "enabled", ask: AiStudioAgentAsk(accessState: "disabled", description: "desc2")))client.getAiStudio().updateAiAgentById(createdAgent.getId(), new CreateAiAgent.Builder(agentName, "enabled").ask(new AiStudioAgentAsk("disabled", "desc2")).build())await client.AiStudio.UpdateAiAgentByIdAsync(agentId: createdAgent.Id, requestBody: new CreateAiAgent(name: agentName, accessState: "enabled") { Ask = new AiStudioAgentAsk(accessState: "disabled", description: "desc2") });{
"id": "1234567890",
"origin": "CUSTOM",
"name": "This is my Agent",
"access_state": "enabled",
"type": "ai_agent",
"created_by": {
"id": "11446498",
"type": "user"
},
"created_at": "2022-01-01T00:00:00Z",
"modified_by": {
"id": "11446498",
"type": "user"
},
"modified_at": "2022-01-01T00:00:00Z",
"icon_reference": "https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg",
"allowed_entities": [
{
"id": "11446498",
"type": "user"
}
],
"ask": {
"type": "ai_agent_ask",
"access_state": "enabled",
"description": "This is ASK Agent",
"custom_instructions": "This is a custom instruction",
"suggested_questions": [
"What is in this file?",
"What are the main highlights of this document?"
],
"long_text": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"embeddings": {
"model": "azure__openai__text_embedding_ada_002",
"strategy": {
"id": "basic",
"num_tokens_per_chunk": 64
}
},
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_text": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_image": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
},
"spreadsheet": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"warnings": [
"MODEL_INACTIVE"
]
},
"long_text_multi": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"embeddings": {
"model": "azure__openai__text_embedding_ada_002",
"strategy": {
"id": "basic",
"num_tokens_per_chunk": 64
}
},
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_text_multi": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_image_multi": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
}
},
"text_gen": {
"type": "ai_agent_text_gen",
"access_state": "enabled",
"description": "This is ASK Agent",
"custom_instructions": "This is a custom instruction",
"suggested_questions": [
"What is in this file?",
"What are the main highlights of this document?"
],
"basic_gen": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, and I have $8000 and want to spend a week in the Azores. `{user_question}`",
"embeddings": {
"model": "azure__openai__text_embedding_ada_002",
"strategy": {
"id": "basic",
"num_tokens_per_chunk": 64
}
},
"content_template": "---{content}---",
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
}
},
"extract": {
"type": "ai_agent_extract",
"access_state": "enabled",
"description": "This is ASK Agent",
"custom_instructions": "This is a custom instruction",
"long_text": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"embeddings": {
"model": "azure__openai__text_embedding_ada_002",
"strategy": {
"id": "basic",
"num_tokens_per_chunk": 64
}
},
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_text": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
},
"basic_image": {
"model": "azure__openai__gpt_4o_mini",
"num_tokens_for_completion": 8400,
"llm_endpoint_params": {
"type": "openai_params",
"temperature": 0,
"top_p": 1,
"frequency_penalty": 1.5,
"presence_penalty": 1.5,
"stop": "<|im_end|>"
},
"system_message": "You are a helpful travel assistant specialized in budget travel",
"prompt_template": "It is `{current_date}`, consider these travel options `{content}` and answer the `{user_question}`.",
"is_custom_instructions_included": false,
"warnings": [
"MODEL_INACTIVE"
]
}
}
}{
"type": "error",
"status": 400,
"code": "item_name_invalid",
"message": "Method Not Allowed",
"context_info": {
"message": "Something went wrong"
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"request_id": "abcdef123456"
}{
"type": "error",
"status": 400,
"code": "item_name_invalid",
"message": "Method Not Allowed",
"context_info": {
"message": "Something went wrong"
},
"help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
"request_id": "abcdef123456"
}このリソースは、バージョン2024.0のエンドポイントで使用されています。 詳細については、 Box APIのバージョン管理を参照してください。「Box SDKのバージョニング戦略について詳しく学ぶ。」
承認
The access token received from the authorization server in the OAuth 2.0 flow.
パスパラメータ
更新するエージェントのID。
ボディ
application/json
AIエージェント作成リクエストのスキーマ。
クエリの処理に使用されるエージェントのタイプ。
利用可能なオプション:
ai_agent 例:
"ai_agent"
AIエージェントの名前。
例:
"My AI Agent"
AIエージェントの状態。使用可能な値はenabled、disabled、enabled_for_selected_usersです。
例:
"enabled"
AIエージェントのアイコン参照。これは、URL https://cdn01.boxcdn.net/app-assets/aistudio/avatars/<file_name>の形式で指定する必要があります。この場合、file_nameに使用可能な値はlogo_boxAi.png、logo_stamp.png、logo_legal.png、logo_finance.png、logo_config.png、logo_handshake.png、logo_analytics.png、logo_classification.pngです。
Minimum string length:
1例:
"https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg"
許可するユーザーまたはグループのリスト。
他のリソース内にネストされたときに使用されるユーザーのMini版の表示。
- ユーザー (Base)
- グループ (Base)
Show child attributes
Show child attributes
クエリの処理に使用するAIエージェント。
Show child attributes
Show child attributes
テキストの生成に使用するAIエージェント。
Show child attributes
Show child attributes
メタデータ抽出に使用するAIエージェント。
Show child attributes
Show child attributes
レスポンス
作成されたAIエージェントの定義。
AIエージェントインスタンスのFull版の表示。
AIエージェントの一意の識別子。
例:
"1234567890"
AIエージェントのプロバイダ。
例:
"CUSTOM"
AIエージェントの名前。
例:
"This is my Agent"
AIエージェントの状態。使用可能な値はenabled、disabled、enabled_for_selected_usersです。
例:
"enabled"
クエリの処理に使用されるエージェントのタイプ。
利用可能なオプション:
ai_agent 例:
"ai_agent"
このエージェントを作成したユーザー。
Show child attributes
Show child attributes
このAIエージェントが作成された時点のISO日時形式のタイムスタンプ。
例:
"2022-01-01T00:00:00Z"
このエージェントを直近で変更したユーザー。
Show child attributes
Show child attributes
このAIエージェントが最近変更された時点のISO日時形式のタイムスタンプ。
例:
"2022-01-01T00:00:00Z"
AIエージェントのアイコン参照。
Minimum string length:
1例:
"https://cdn01.boxcdn.net/app-assets/aistudio/avatars/logo_analytics.svg"
許可するユーザーまたはグループのリスト。
他のリソース内にネストされたときに使用されるユーザーのMini版の表示。
- ユーザー (Base)
- グループ (Base)
Show child attributes
Show child attributes
質問に使用するAIエージェント。
Show child attributes
Show child attributes
テキストの生成に使用するAIエージェント。
Show child attributes
Show child attributes
メタデータ抽出に使用するAIエージェント。
Show child attributes
Show child attributes
最終更新日 2026年1月23日
このページは役に立ちましたか？
⌘I