Rensei docs
API ReferenceWorkflows

Manually trigger a published workflow.

Manually trigger a published workflow. - Rensei REST API operation reference.

POST
/api/workflows/{id}/trigger

Authorization

headerAuthorizationBearer <rsk_live_*>

Rensei API key presented as Authorization: Bearer rsk_live_. Required API-key scopes are recorded per operation in x-rensei-required-scopes.

Path Parameters

id*string

Workflow id.

Header Parameters

Idempotency-Key?string

Alternative to body idempotencyKey; both must match when supplied together.

Length1 <= length <= 256

Request Body

application/json
  1. body
idempotencyKey?string

Retry key, scoped to this workflow and caller for 24 hours. Idempotency-Key header is also accepted. Fire-and-forget only; conflicting payloads return 409.

Length1 <= length <= 256
params?

Trigger params surfaced as trigger.data.

poolId?string

Per-dispatch execution-pool override.

pinStrict?boolean

Fail-closed strictness for the poolId pin. When true, an unavailable or offline pinned pool abandons the dispatch instead of falling back. Default false. Requires poolId.

triggerId?string

Scope a multi-trigger workflow to a single trigger node.

businessDate?string

Business date (YYYY-MM-DD) for the run completion receipt; carried as trigger.data.localDate.

Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Formatdate
mode?string

Synchronous launch-return mode. Only valid for a workflow whose canvas contains an interactive.session.launch node: the instance runs INLINE up to the fire-and-suspend wait gate and the response carries the launched sessionId/metaId synchronously (the instance then parks on the wait gate as usual). Omit for the default fire-and-forget behaviour.

Response Body

Instance created, or an idempotent replay returns the existing instance and its current status. Fire-and-forget (default): status:"pending", execution scheduled after the response. Synchronous mode:"launch-return": the launch ran inline and sessionId/metaId are present with status reflecting the settled disposition (suspended once parked on the wait gate).

application/json
  1. response
instanceId*string
workflowId*string
status*string
sessionId?string

Launched interactive sessionId — present only in launch-return mode.

metaId?string

interactive_session_meta.id — present only in launch-return mode.

Example Request
curl -X POST 'https://app.rensei.ai/api/workflows/string/trigger' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "instanceId": "string",  "workflowId": "string",  "status": "string",  "sessionId": "string",  "metaId": "string"}

List runs (instances) of a workflow.

List runs (instances) of a workflow. - Rensei REST API operation reference.

Validate the current stored workflow without writing or executing it.

Checks one freshly authorized saved workflow snapshot under the existing project and Cedar edit-workflow decision. A valid result covers only the compiler checks represented by this endpoint; it does not establish publish, execution, or recipient readiness.