Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-26104203277.0 KB

Update Web Tool

Updates an existing web tool by ID. All fields are optional except projectId.

patch/v2/voice-agents/web-tool/{id}

Path parameters

idstring uuid required
Example:48f7656f-098b-4c43-b165-7cfd2cc8ac30

The unique identifier of the web tool to update

Request body

type'FUNCTION' | 'MCP' | 'WEB_TOOL'

The type of web tool

namestring

The name of the web tool

descriptionstring

A description of what the web tool does

asyncboolean

Whether the tool runs asynchronously. Not allowed for MCP type.

Example request

{
  "type": "FUNCTION",
  "name": "Get Weather Data",
  "description": "Fetches current weather data for a given location",
  "toolSettings": {
    "serverUrl": "https://api.example.com/weather",
    "methodType": "GET",
    "authToken": "Bearer sk-...",
    "timeOut": 5,
    "httpHeaders": {
      "Content-Type": "application/json"
    },
    "pathParameters": {
      "city": "london"
    }
  },
  "messages": [
    {
      "type": "REQUEST_START",
      "content": "Fetching weather data..."
    }
  ],
  "params": {
    "type": "object",
    "properties": {
      "location": {
        "type": "string",
        "description": "The city name to get weather for"
      },
      "units": {
        "type": "string",
        "description": "Temperature units",
        "enum": [
          "celsius",
          "fahrenheit"
        ]
      }
    },
    "required": [
      "location"
    ]
  }
}

Response

Web tool updated successfully

successboolean

Example response

{
  "success": true,
  "data": {
    "id": "48f7656f-098b-4c43-b165-7cfd2cc8ac30",
    "persistentId": "48f7656f-098b-4c43-b165-7cfd2cc8ac30",
    "version": 1,
    "name": "Get Weather Data",
    "type": "FUNCTION",
    "userId": "48f7656f-098b-4c43-b165-7cfd2cc8ac30",
    "projectId": "48f7656f-098b-4c43-b165-7cfd2cc8ac30",
    "isActive": true,
    "description": "Fetches current weather data for a given location",
    "collectionId": "48f7656f-098b-4c43-b165-7cfd2cc8ac30",
    "messages": [
      {
        "type": "REQUEST_START",
        "content": "Fetching weather data..."
      }
    ]
  }
}