CodeInterpreterToolboxTool interface
A code interpreter tool stored in a toolbox.
- Extends
Properties
| allowed_callers | The callers that may invoke this code interpreter toolbox tool, either directly or programmatically. |
| container | The code interpreter container. Can be a container ID or an object that
specifies uploaded file IDs to make available to your code, along with an
optional |
| type | The type of the code interpreter toolbox tool. Always |
Inherited Properties
| description | Optional user-defined description for this tool or configuration. |
| name | Optional user-defined name for this tool or configuration. |
| tool_configs | Per-tool configuration map. Keys are tool names or |
Property Details
allowed_callers
The callers that may invoke this code interpreter toolbox tool, either directly or programmatically.
allowed_callers?: CallableToolAllowedCaller[]Property Value
container
The code interpreter container. Can be a container ID or an object that
specifies uploaded file IDs to make available to your code, along with an
optional memory_limit setting.
If not provided, the service assumes auto.
container?: string | AutoCodeInterpreterToolParamProperty Value
string | AutoCodeInterpreterToolParam
type
The type of the code interpreter toolbox tool. Always code_interpreter.
type: "code_interpreter"Property Value
"code_interpreter"
Inherited Property Details
description
Optional user-defined description for this tool or configuration.
description?: stringProperty Value
string
Inherited From ToolboxTool.description
name
Optional user-defined name for this tool or configuration.
name?: stringProperty Value
string
Inherited From ToolboxTool.name
tool_configs
Per-tool configuration map. Keys are tool names or * (catch-all default).
Resolution order: exact tool name match takes priority over *.
Unknown tool names are silently ignored at runtime.
tool_configs?: Record<string, ToolConfig>Property Value
Record<string, ToolConfig>
Inherited From ToolboxTool.tool_configs