Skip to content
Menu
All API groups

Jobs

Background jobs.

1 endpoint.

GET/v1/jobs/{job_id}

Background job status (poll until it is finished)

Needs a key or a dashboard session

Parameters

NameInTypeRequiredDescription
job_idpathstringyes

Responses

  • 200Successful ResponseJob

Data shapes on this page

Job

A row of the shared `jobs` table. Poll GET /v1/jobs/{id} until status is terminal.

NameTypeRequiredDescription
idstringyes
kind"reindex" | "import" | "sync" | "translate_backfill" | "translate_writeback" | "export" | "data_export" | "data_delete" | "embed" | "synonym_mining"yes
status"queued" | "running" | "succeeded" | "failed" | "canceled"yes
progressnumbernodefault 0 · min 0 · max 1
created_atstring (date-time)yes
started_atstring (date-time) | nullno
finished_atstring (date-time) | nullno
resultobject | nullno
errorstring | nullno