Sign in

v3

latestOpenAPI 3.0.02026-08-081996601.2 MB
Jobs

Get a job by ID

Returns the job with the specified job_id. Jobs are background processes, such as replacing the filterable metadata attributes.

get/v2/jobs/{job_id}

Path parameters

job_idstring required

The ID of the job to get.

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Response

A job.

idstring required

The ID of the job.

type'rebuild_vector_index' | 'replace_filter_attributes' | 'bulk_delete_documents' | 'bulk_update_document_metadata' | 'unknown'

The type of job.

corpus_keysCorpusKey[]

The corpora that this job belongs to. Some jobs do not belong to any corpus.

state'unknown' | 'queued' | 'started' | 'completed' | 'failed' | 'failed_will_retry' | 'aborted'

The state of a background job.

created_atstring date-time

When the job was created.

started_atstring date-time

When the job was started.

completed_atstring date-time

When the job was completed.

created_by_usernamestring

The username of the user who created the job. This property can be absent, for example when the platform created the job.

commentstring

A human-readable explanation of the job's current status. The format and content depend on the job type. On failure, this property contains the error message. This property can be absent.

Example response

{
  "id": "job_1234",
  "corpus_keys": [
    "my-corpus"
  ]
}