Skip to main content
PATCH
/
v1
/
custom-tools
/
{id}
Patch custom tool
curl --request PATCH \
  --url https://api.conduit.ai/v1/custom-tools/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Look up live fulfillment status of an order by id.",
  "code": "def main(**params):\n    order_id = params[\"order_id\"]\n    return {\"message\": f\"Order {order_id} is out for delivery\"}"
}
'
{
  "data": {
    "id": "kg77c0dy0mgdpzmqz6tesry8w184002s",
    "workspace_id": "j57demo8f8x7c9v0n2q4r6t8y1u3i5o",
    "name": "lookup-order-status",
    "description": "Look up the fulfillment status of an order by id.",
    "language": "python",
    "code": "def main(**params):\n    order_id = params[\"order_id\"]\n    # ... fetch status ...\n    return {\n        \"message\": f\"Order {order_id} is shipped\",\n        \"rawData\": {\"status\": \"shipped\"},\n    }",
    "parameters": {
      "order_id": {
        "type": "string",
        "required": true,
        "description": "The order id to look up."
      }
    },
    "execution_message_description": "Looking up order status",
    "enable_globally": false,
    "validated": true,
    "version": 1,
    "created_at": "2026-04-01T17:22:10.000Z"
  }
}

Authorizations

​
Authorization
string
header
required

Conduit API token. Use Authorization: Bearer <token>. Read/write endpoints require a token with write access.

Path Parameters

​
id
string
required

Custom tool id.

Example:

"kg77c0dy0mgdpzmqz6tesry8w184002s"

Query Parameters

​
workspace_id
string

Optional workspace override. If omitted, Conduit resolves the tool's workspace automatically.

Example:

"j57demo8f8x7c9v0n2q4r6t8y1u3i5o"

Body

application/json

Request body for patching a custom code tool. Only supplied fields are changed. Changing code bumps the tool's version.

​
name
string

Unique tool name within the workspace. Lowercase kebab-case (e.g. lookup-order-status), at most 64 characters. This is how the agent references the tool.

Required string length: 1 - 64
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
​
description
string
Maximum string length: 1024
​
language
enum<string>

Runtime the tool's code is executed in. Determines the entrypoint signature and which dependencies are available (see GET /v1/custom-tools/runtimes).

Available options:
python,
javascript
​
code
string

The tool's source code. Must define a single entrypoint named main.

Python: def main(**params): — parameters arrive as keyword args. Return a dict containing a string message key, optionally a rawData key with structured data.

JavaScript: async function main(params) { ... } — parameters arrive as a single object. Return an object containing a string message key, optionally a rawData key.

Writes statically validate that the code defines main and includes a return statement; runtime execution validates the returned object.

Standard library modules are always importable. A curated set of third-party packages installs automatically on first import. Query GET /v1/custom-tools/runtimes for the exact signature, return contract, and available dependencies per language.

Minimum string length: 1
​
parameters
object

Parameters the tool accepts, keyed by parameter name. Each becomes a key in the params object/dict passed to main.

​
execution_message_description
string
​
enable_globally
boolean

Response

Custom tool updated

Single custom code tool response.

​
data
object
required