v1

latestOpenAPI 3.0.02026-07-26870415.2 KB

custom_tools

Create custom tool

Creates a custom code tool. Requires a token with write access. See GET /v1/custom-tools/runtimes for the code contract.

post/v1/custom-tools

Request body

workspace_idstring required

namestring required

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.

descriptionstring

language'python' | 'javascript' required

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

codestring required

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.

parametersobject

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

execution_message_descriptionstring

Short status line shown to the user while the tool runs, e.g. Looking up order status.

enable_globallyboolean

When true, the tool is available to every agent in the workspace without per-agent enablement.

Example request

{
  "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    return {\"message\": f\"Order {order_id} is shipped\"}",
  "parameters": {
    "order_id": {
      "type": "string",
      "required": true,
      "description": "The order id to look up."
    }
  },
  "execution_message_description": "Looking up order status",
  "enable_globally": false
}

Response

Custom tool created

Example response

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