Skip to main content
POST
Start Workflow run

Authorizations

Authorization
string
header
required

OAuth Bearer access tokens or Flow API keys with the required Flow scope families for the route.

Headers

Idempotency-Key
string

Optional idempotency key for retry-safe write operations. For implemented representative writes, the same key plus the same request fingerprint replays the accepted result with meta.replayed=true in the response body. Stored HTTP responses for create requests in the customer API retain their original success status, including 201 Created and 202 Accepted. An in-progress key returns 409 idempotency_key_in_progress. A reused key with a different request fingerprint returns 409 idempotency_key_reused. Replay state is not signaled through an X-Idempotent-Replayed header.

Maximum string length: 255
X-Correlation-Id
string

Optional caller-supplied correlation identifier propagated into canonical workflow handles.

traceparent
string

Optional W3C trace context header accepted by shared request-context middleware.

X-Flow-Source-Surface
enum<string>

Optional source-surface hint. When both this header and a request body source_surface_kind are present, they must match.

Available options:
api,
cli,
browser,
email

Body

application/json
data
object
required

Response

Workflow run creation receipt.

data
object
required
meta
object
required