Skip to main content
POST
Run a flow now

Authorizations

Authorization
string
header
required

This access token needs to be included in each of your request to the Chift API.

Path Parameters

syncid
string
required
flowid
string
required

Body

application/json

Run a flow now.

Settings apply to a single consumer: pass several only for a plain run with no settings.

consumers
(string<uuid> | string)[]

Consumer ids, or the single value 'all' for every consumer of the sync.

settings
FlowSettings · object

The settings one execution was started with.

Shared by every sync and never subclassed, so flow.settings.<setting> has one static type everywhere. Per-sync variance lives in :class:FlowSettingsSpec (which settings a sync supports, its tooltips, its extra fields) — never in this model.

Read it through the derived properties rather than the raw fields: they are the only thing a sync should branch on, and they are what keeps a setting's scope from leaking into another's.

preflight
boolean
default:false

Check the request without starting anything. Everything that decides whether the run may start is evaluated, and a refusal comes back as a blocking warning rather than an error, so you can warn someone before they confirm.

only
OnlyObjects · object | null

An agentic sync only, for exactly one consumer: book these objects only.

Response

Successful Response

resolved_settings
FlowSettings · object
required

The settings one execution was started with.

Shared by every sync and never subclassed, so flow.settings.<setting> has one static type everywhere. Per-sync variance lives in :class:FlowSettingsSpec (which settings a sync supports, its tooltips, its extra fields) — never in this model.

Read it through the derived properties rather than the raw fields: they are the only thing a sync should branch on, and they are what keeps a setting's scope from leaking into another's.

chainexecutionid
string | null

Unset for a preflight: nothing was started.

consumers
ExecutionConsumerResult · object[]
preview_executionid
string | null
warnings
ExecutionWarning · object[]
blocked
boolean
default:false

Only a preflight reports this: the same request sent for real would be refused.