v1

latestOpenAPI 3.0.02026-07-26870415.2 KB

custom_tools

Run custom tool

Executes a custom code tool with the given parameters and returns its result. The code runs in the sandbox exactly as an agent would invoke it. A tool whose own code fails still returns 200 with success: false; a non-2xx only means the tool was not found or the arguments were rejected. Requires a token with write access.

post/v1/custom-tools/{id}/run

Path parameters

idstring required

Custom tool id.

Example:kg77c0dy0mgdpzmqz6tesry8w184002s

Request body

workspace_idstring

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

parametersobject

Arguments passed to the tool's main entrypoint, keyed by parameter name. Every parameter the tool marks as required must be present.

Example request

{
  "workspace_id": "j57demo8f8x7c9v0n2q4r6t8y1u3i5o",
  "parameters": {
    "order_id": "ord_12345"
  }
}

Response

Custom tool run result

Example response

{
  "data": {
    "success": true,
    "message": "Order ord_12345 is shipped",
    "result": {
      "message": "Order ord_12345 is shipped",
      "rawData": {
        "status": "shipped"
      }
    },
    "error": null,
    "logs": null,
    "run_time_ms": 842
  }
}