Sample - Box Platform API
GET/ai_agent_default

Get the default AI agent configuration

Retrieves the default AI agent configuration for a requested operation mode. Use mode to select question answering, text generation, or metadata extraction, and optionally use language and model to refine the configuration returned. If the requested language is unsupported, the default language configuration is returned.

3 parameters
modestringrequired
The operation mode to retrieve configuration for: `ask`, `text_gen`, `extract`, or `extract_structured`.
Allowed:asktext_genextractextract_structured
languagestringoptional
The ISO language code for the requested agent configuration. An unsupported language falls back to the default configuration.
modelstringoptional
The model for which to retrieve the default agent configuration.

3 status codes
200Returns the default AI agent configuration for the requested mode, optionally filtered by language and model.
typestringrequired
The type of AI agent used to handle queries.
Allowed:ai_agent_ask
long_textobjectoptional
AI agent processor used to to handle longer text.
basic_textobjectoptional
AI agent processor used to handle basic text.
spreadsheetobjectoptional
The AI agent tool used to handle spreadsheets and tabular data.
long_text_multiobjectoptional
AI agent processor used to to handle longer text.
basic_text_multiobjectoptional
AI agent processor used to handle basic text.
basic_imageobjectoptional
AI agent processor used to handle basic text.
basic_image_multiobjectoptional
AI agent processor used to handle basic text.
500Returned when an unexpected server error occurs.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.
defaultAn unexpected error.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.

Error handling

mode is required and must be one of ask, text_gen, extract, or extract_structured. An unsupported language falls back to the default agent configuration, while a 500 indicates an unexpected server error.