Sync a source into its collection now
Queue an ingestion run. It returns 202 as soon as the job is recorded, before anything is ingested, and is idempotent while a run for that source is active.
POST
Returns
202 as soon as the job is recorded. Nothing has been ingested yet. Poll Get a job with the returned id, or Get a source’s latest job, until is_active is false.
Syncing is idempotent while a run is active. If the source already has a pending, queued or running job, you get that job back with 202 and no second run starts. Retrying a request is therefore safe.
A sync always re-reads the whole source, even when the source version has not changed. Documents whose content is unchanged are counted as documents_unchanged and are not re-indexed. If the source’s collection is archived, the sync is accepted and the job ends failed.
Syncing requires a role that can add documents. A read-only member receives 403. An unknown ID, a malformed ID, or another organization’s source returns 404. See Ingestion.
string
required
Source ID (a UUID).
Response
Returns202 with the job. A new job has status queued, trigger manual and all counters at 0.
string
required
Job ID (a UUID).
string
required
Collection being ingested into.
string
required
Source being ingested.
string
required
pending, queued, running, succeeded, partial, failed, cancelled or skipped. See
Get a job for what each means.string
required
manual, scheduled or api.string | null
required
Source version the run read, such as a commit SHA.
null until the run starts.boolean
required
true while the status is pending, queued or running.integer
required
Which attempt this is, starting at
1.integer
required
Total attempts allowed.
string | null
required
ISO 8601 timestamp, in UTC, when the current attempt was queued.
string | null
required
ISO 8601 timestamp, in UTC, when the current attempt started.
string | null
required
ISO 8601 timestamp, in UTC, when the job ended.
string | null
required
ISO 8601 timestamp, in UTC, before which a queued retry will not start.
string | null
required
Stable error code when the run failed. Otherwise
null.string | null
required
Readable description of the failure. Otherwise
null.object
required
documents_discovered, documents_ingested, documents_unchanged, documents_skipped,
documents_failed, documents_deleted, chunks_written and bytes_fetched, all integers. See
Get a job.Last modified on September 26, 2026