Modify a specific tool

Modify a specific tool.

Needs user bearer token in authorization header.

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

toolbox_idToolbox Id

A 24-character hexadecimal MongoDB ObjectId string.

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

tool_idTool Id

A 24-character hexadecimal MongoDB ObjectId string.

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

Header Parameters

OpenAI-Organization?Openai-Organization

OpenAI-Project?Openai-Project

Request Body

server_label?Server Label

server_url?Server Url

allowed_tools?Allowed Tools

headers?Headers

require_approval?Require Approval

server_description?Server Description

background?Background

input_image_mask?InputImageMask | null

model?Model

moderation?Moderation

output_compression?Output Compression

output_format?Output Format

partial_imagesPartial Images

quality?Quality

size?Size

vector_store_ids?Vector Store Ids

filters?Filters

max_num_results?Max Num Results

ranking_options?RankingOptions | null

Response Body

curl -X POST "https://loading/toolboxes/5eb7cf5a86d9755df3a6c593/tools/5eb7cf5a86d9755df3a6c593" \
  -H "OpenAI-Organization: 5eb7cf5a86d9755df3a6c593" \
  -H "OpenAI-Project: 5eb7cf5a86d9755df3a6c593" \
  -H "Content-Type: application/json" \
  -d '{}'

{
  "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.