Skip to main content
POST
Start a workflow

Authorizations

Authorization
string
header
required

API key sent as Authorization: Bearer <key>. Needed only when the server has a key configured.

Headers

Idempotency-Key
string

Body

application/json

Request object for starting a workflow

sessionId
string
required

The unique session identifier

Maximum string length: 256
Pattern: ^(?!.*\.\.)[^/\\]*$
Example:

"session-123"

workflowId
string
required

The unique workflow identifier

Minimum string length: 1
Example:

"quality-check"

payload
object

Optional trigger payload passed to the workflow's trigger node

Response

202 - */*

Accepted

Unified API response wrapper for both success and error responses. Success responses include data field; error responses include error, path, and errors fields.

timestamp
string<date-time>

The time the response was generated

status
integer<int32>

The HTTP status code

Example:

200

message
string

A human-readable message

Example:

"Operation successful"

data
object

The response data

error
string

The HTTP status error name

Example:

"Bad Request"

path
string

The request path

Example:

"/api/files"

errors
object[]

The list of field validation errors