PUT
/
tools
/
{id}
curl --request PUT \
  --url http://localhost/api/v1/tools/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "display_name": "<string>",
  "description": "<string>",
  "permission": "read_only",
  "input_schema": {
    "type": "object",
    "properties": {},
    "required": [
      "<string>"
    ]
  },
  "output_schema": {
    "type": "object",
    "description": "<string>",
    "properties": {},
    "required": [
      "<string>"
    ]
  },
  "binding": {
    "openapi": {
      "http_method": "GET",
      "http_path": "<string>",
      "security": [],
      "servers": [],
      "connection_id": "<string>"
    },
    "python": {
      "function": "<string>",
      "requirements": [
        "<string>"
      ],
      "connections": {}
    },
    "wxflows": {
      "endpoint": "<string>",
      "flow_name": "<string>",
      "security": []
    },
    "skill": {
      "skillset_id": "<string>",
      "skill_id": "<string>",
      "skill_operation_path": "<string>",
      "http_method": "GET"
    },
    "client_side": {},
    "rag": {
      "vector_id": "<string>"
    },
    "conversational_search": {
      "conversational_search_config": {},
      "connections": [
        "<any>"
      ],
      "version": "0.0.1"
    },
    "mcp": {
      "server_url": "<string>",
      "source": "public-registry",
      "env": {},
      "command": "<string>",
      "args": [
        "<string>"
      ],
      "connections": {}
    }
  }
}'
"<any>"

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

application/json

A specification for a tool that can be used in an agent.

Response

200
application/json

Successful Response

The response is of type any.