Skip to main content
POST
/
v1
/
workflows
/
{id}
/
run
Error
A valid request URL is required to generate request examples

Authorizations

Authorization
string
header
required

Org API key (scopes the request to its organization) or the shared trusted key (requires X-Organization-Id on every request).

Headers

X-Organization-Id
string

Organization to scope the request to. Optional when authenticating with an org API key (the org is taken from the key; if sent, it must match). Required when authenticating with the trusted key.

X-User-Id
string

End-user identity for the request; user-scoped data (threads, memory) resolves to {orgId}_{userId}. Required by endpoints that read or write user-scoped resources. A userId query param (or body field, where documented) is accepted as a fallback.

Path Parameters

id
string
required

Query Parameters

version
string
default:active

active (default) | draft | v{n}

Body

application/json
input
any

The workflow input (validated against the version's input schema by the run)

groupId
string | null

Optional STABLE caller-supplied chatter group id (chatter_groups.external_id). When sent, group matching is by this id; a differing groupName renames the group.

Required string length: 1 - 255
groupName
string | null

Optional chatter group name. Without groupId this matches/provisions by name (legacy behavior); alongside groupId it is display-only (rename on change).

runtimeAuth
object

Runtime authentication map: { [providerNameOrId]: { credentials } } — used by tool steps (custom + MCP)

Response

Run completed