Skip to main content
POST
Trigger a workflow run

Authorizations

x-metal-client-id
string
header
default:<client-id>
required

The Client ID of your API key.

x-metal-api-key
string
header
default:<api-key>
required

The secret value of your API key.

Path Parameters

id
string
required

The workflow id.

Body

application/json
input
object

The input payload the workflow expects.

dryRun
boolean
default:false

When true, the run validates gated tool calls (write and destructive tools) against their input schema instead of executing them. Read-only tools still run so the agent can gather context, and permission prompts are skipped.

Response

The created run.

data
object