Pipelines

Run sync for a pipeline

Triggers an ad-hoc sync run for the pipeline and streams NDJSON messages (records, state, progress, eof) back to the client. Persists the ending sync_state on the pipeline so the next run resumes where this one left off.

post/pipelines/{id}/sync

Path parameters

idstring required

Unique pipeline identifier (e.g. pipe_abc123).

Example:pipe_abc123

Unique pipeline identifier (e.g. pipe_abc123).

Query parameters

state_limitnumber

Max state messages before stopping

Max state messages before stopping

time_limitnumber

Stop after N seconds

Stop after N seconds

sync_run_idstring

Sync run identifier (resumes or starts fresh)

Sync run identifier (resumes or starts fresh)

no_stateboolean

Ignore and do not persist the pipeline sync_state checkpoint

Ignore and do not persist the pipeline sync_state checkpoint

Request body

Response

Streaming NDJSON sync output

Changes