Skip to main content
POST
workflow.run

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
workflowId
string
required

The identifier of a workflow defined in your own account or code.

Required string length: 1 - 256
Pattern: ^[A-Za-z0-9_.:-]+$
input
required

Workflow input as JSON, up to 1 MiB. It may contain personal data; it is forwarded to your account.

options
object

Explicit execution overrides. Unspecified options use your workflow's settings.

Response

The result

accepted
boolean
required

The workflow was accepted; this does not mean it finished.

executionId
string
required

The execution identifier in your connected account.

Required string length: 1 - 256
Pattern: ^[A-Za-z0-9_.:-]+$