Tools

Tools give assistants access to native AI provider capabilities like web search, file search, code interpreter, image generation, and computer use.

Endpoints

Manage assistant tools with these REST endpoints.

List toolsRetrieve a list of tools

Create toolCreate a new tool

Get toolRetrieve a specific tool

Update toolUpdate an existing tool

Delete toolDelete an existing tool

`Tool` type

Parameter	Type	Description
`id`	string	Unique identifier for the tool
`type`	string	Tool type: `WEB_SEARCH`, `FILE_SEARCH`, `CODE_INTERPRETER`, `IMAGE_GENERATION`, or `COMPUTER_USE`
`fileSearchTool`	object?	Present when type is `FILE_SEARCH`
`webSearchTool`	object?	Present when type is `WEB_SEARCH`
`codeInterpreterTool`	object?	Present when type is `CODE_INTERPRETER`
`imageGenerationTool`	object?	Present when type is `IMAGE_GENERATION`
`computerUseTool`	object?	Present when type is `COMPUTER_USE`
`createdAt`	string	Timestamp when the tool was created
`updatedAt`	string	Timestamp when the tool was last updated

Type-specific fields

`fileSearchTool`

Field	Type	Description
`vectorStoreIds`	string[]	IDs of vector stores to search
`maxNumResults`	number	Maximum number of results to return

`imageGenerationTool`

Field	Type	Description
`model`	string	Model to use (e.g. `gpt-image-1`)
`quality`	string	`AUTO`, `LOW`, `MEDIUM`, or `HIGH`
`size`	string	`AUTO`, `SIZE_1024_1024`, `SIZE_1024_1536`, or `SIZE_1536_1024`
`outputFormat`	string	`PNG`, `WEBP`, or `JPEG`
`background`	string	`AUTO`, `TRANSPARENT`, or `OPAQUE`
`partialImages`	number	Number of partial images

`computerUseTool`

Field	Type	Description
`displayWidth`	number	Display width in pixels (640–4096)
`displayHeight`	number	Display height in pixels (480–4096)
`environment`	string	`LINUX`, `WINDOWS`, `MACOS`, or `BROWSER`
`mcpServerId`	string?	ID of the linked MCP server

webSearchTool and codeInterpreterTool have no configurable fields.

Example tool

{ "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "type": "IMAGE_GENERATION", "imageGenerationTool": { "model": "gpt-image-1", "quality": "HIGH", "size": "SIZE_1024_1024", "outputFormat": "PNG", "background": "AUTO", "partialImages": 0 }, "createdAt": "2024-01-15T10:30:00Z", "updatedAt": "2024-01-15T10:30:00Z" }

Tool availability

Not all tools are available for every provider configuration. The available combinations are:

Tool type	Provider + Storage combinations
`WEB_SEARCH`	Anthropic + Superinterface Cloud, OpenAI + Responses API, Azure OpenAI + Responses API
`FILE_SEARCH`	OpenAI + Responses API, Azure OpenAI + Responses API, OpenAI + Assistants API, Azure OpenAI + Assistants API, Azure AI + Agents
`IMAGE_GENERATION`	OpenAI + Responses API, Azure OpenAI + Responses API
`COMPUTER_USE`	Anthropic + Superinterface Cloud, OpenAI + Responses API, Azure OpenAI + Responses API
`CODE_INTERPRETER`	Anthropic + Superinterface Cloud, OpenAI + Responses API, Azure OpenAI + Responses API, OpenAI + Assistants API, Azure OpenAI + Assistants API, Azure AI + Agents

Creating a tool with an unavailable type for the assistant's provider configuration will return a 400 error.

Tools

Endpoints

Tool type