Skip to main content
POST
/
v1
/
custom-tools
/
{id}
/
run
Run custom tool
curl --request POST \
  --url https://api.conduit.ai/v1/custom-tools/{id}/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspace_id": "j57demo8f8x7c9v0n2q4r6t8y1u3i5o",
  "parameters": {
    "order_id": "ord_12345"
  }
}
'
{
  "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
  }
}

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"

Body

application/json

Request body for running a custom code tool. Requires a token with write access since execution can have side effects.

​
workspace_id
string

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

Example:

"j57demo8f8x7c9v0n2q4r6t8y1u3i5o"

​
parameters
object

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

Response

Custom tool run result

Result of executing a custom code tool. A non-2xx is only returned when the tool could not be found or the arguments were rejected; a tool whose code fails returns 200 with success: false.

​
data
object
required