Skip to main content
POST
Trigger a workflow

Idempotency

Send an optional Idempotency-Key request header to make a trigger safe to retry. The value must be a GUID.
  • A request whose key is missing or is not a valid GUID is processed normally, with no idempotency protection.
  • While a request with a given key is in flight, or after it has completed, a second request with the same key returns 409 Conflict.
  • If the request fails, its pending marker is released automatically, so you can safely retry the same key.

Response status

The response reports the document’s fate: queued when a run has been queued, or held when the workflow’s webhook trigger has Run automatically turned off and the document is held.

Correlation ID

Every response includes an X-Correlation-ID header, a server-generated identifier for the request. Include it when contacting support so a specific request can be traced.
Any X-Correlation-ID you send on the request is ignored at the public edge; the platform always mints a fresh id and returns it on the response.

Authorizations

X-Api-Key
string
header
required

Headers

Idempotency-Key
string<uuid>

Optional GUID that makes the request idempotent. A duplicate request with the same key returns 409 while the first is in flight or after it completed.

Path Parameters

workflowId
string<uuid>
required

The ID of the workflow to trigger.

Body

multipart/form-data
file
file
required

Response

Accepted

documentId
string<uuid>
required
status
string
required