DeepFellow DOCS

Create a new tool for specific toolbox

Create a new tool.

Needs user bearer token in authorization header.

POST
/toolboxes/{toolbox_id}/tools
AuthorizationBearer <token>

In: header

Path Parameters

toolbox_idToolbox Id

A 24-character hexadecimal MongoDB ObjectId string.

Match^[0-9a-fA-F]{24}$

Header Parameters

OpenAI-Organization?Openai-Organization
OpenAI-Project?Openai-Project
type?Type
Default"image_generation"
vector_store_idsVector Store Ids

List of vector store IDs to search

filters?Filters

Filter to apply to results

max_num_results?Max Num Results

Maximum number of results

Default25
Range1 <= value <= 50
ranking_options?RankingOptions | null

Ranking options

server_labelServer Label

Label for MCP server identification

server_urlServer Url

URL for MCP server endpoint

allowed_tools?Allowed Tools

List of allowed tool names or filter object

headers?Headers

HTTP headers to send

require_approval?Require Approval

Tools requiring approval. Defaults to 'always'

Default"always"
server_description?Server Description
Default""
background?Background

Background type for generated image

Default"auto"
input_image_mask?InputImageMask | null

Mask for inpainting operation containing image URL or file ID

modelModel

Generation model to use

moderation?Moderation

Moderation level

Default"auto"
output_compression?Output Compression

Output compression level (0-100)

Default100
output_format?Output Format

Output format for generated image

Default"png"
partial_images?Partial Images

Number of partial images to generate in streaming mode (0-3)

Default0
quality?Quality

Quality level for image

Default"auto"
size?Size

Generated image dimensions (pixel)

Default"auto"

Response Body

curl -X POST "https://loading/toolboxes/5eb7cf5a86d9755df3a6c593/tools" \
  -H "OpenAI-Organization: 5eb7cf5a86d9755df3a6c593" \
  -H "OpenAI-Project: 5eb7cf5a86d9755df3a6c593" \
  -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"
    }
  ]
}

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.