Create a new tool for specific toolbox
Create a new tool.
Needs user bearer token in authorization header.
In: header
Path Parameters
A 24-character hexadecimal MongoDB ObjectId string.
^[0-9a-fA-F]{24}$Header Parameters
Organization Id from OpenAi compatible endpoint. Required to organization access or project access (with OpenAI-Project header) when logged as User or Admin User.
Project Id from OpenAi compatible endpoint. Required to project access for organization api key or User / Admin User access with OpenAI-Organization
"file_search"List of vector store IDs to search
Filter to apply to results
Maximum number of results
251 <= value <= 50Ranking options
"mcp"Label for MCP server identification
URL for MCP server endpoint
List of allowed tool names or filter object
HTTP headers to send
Tools requiring approval. Defaults to 'always'
"always""""image_generation"Background type for generated image
"auto"Mask for inpainting operation containing image URL or file ID
Generation model to use
Moderation level
"auto"Output compression level (0-100)
100Output format for generated image
"png"Number of partial images to generate in streaming mode (0-3)
0Quality level for image
"auto"Generated image dimensions (pixel)
"auto""infra-mcp"Label for MCP server identification
Deepfellow MCP server prefix (from DeepFellow Infra)
MCP transport type
"mcp""mcp" | "sse"List of allowed tool names or filter object
HTTP headers to send
Tools requiring approval. Defaults to 'always'
"always""""custom-mcp"Label for MCP server identification
""Custom endpoint prefix
Constant HTTP headers to send
Tools requiring approval. Defaults to 'always'
"always"List of tools.
[]"websearch"Tools requiring approval. Defaults to 'always'
"always"Response Body
curl -X POST "https://loading/toolboxes/5eb7cf5a86d9755df3a6c593/tools" \ -H "OpenAI-Organization: string" \ -H "OpenAI-Project: string" \ -H "Content-Type: application/json" \ -d '{ "vector_store_ids": [ "5eb7cf5a86d9755df3a6c593" ] }'{
"id": "5eb7cf5a86d9755df3a6c593",
"definition": {
"type": "file_search",
"vector_store_ids": [
"5eb7cf5a86d9755df3a6c593"
],
"filters": {
"filters": [
{
"key": "string",
"type": "eq",
"value": "string"
}
],
"type": "and"
},
"max_num_results": 25,
"ranking_options": {
"ranker": "auto",
"score_threshold": 0
}
},
"toolbox_id": "5eb7cf5a86d9755df3a6c593",
"created_at": 0
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}We use cookies on our website. We use them to ensure proper functioning of the site and, if you agree, for purposes such as analytics, marketing, and targeting ads.