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

time_limitnumber

Stop after N seconds

Stop after N seconds

run_idstring

Sync run identifier (resumes or starts fresh)

Sync run identifier (resumes or starts fresh)

reset_stateboolean

Ignore persisted sync state and start fresh (ending state is still saved)

Ignore persisted sync state and start fresh (ending state is still saved)

Request body

Response

Streaming NDJSON sync output

Changes