Sign in
jobs

Get Job Status

Get status, progress, and file-level details for an indexing job. Use files_limit and files_cursor to page through indexed files when the job contains many inputs.

get/v2/jobs/{job_id}

Path parameters

job_idstring required

ID of the job to look up, as returned by the indexing endpoint that started it.

Query parameters

files_limitinteger

Number of files to return per page

files_cursorstring nullable

Pagination cursor for files

Headers

authorizationstring nullable

Response

Successful Response

cancelled_atstring nullable

RFC 3339 timestamp when the job was cancelled.

collection_namestring nullable

Name of the collection this job is indexing into.

completed_atstring nullable

RFC 3339 timestamp when the job reached a terminal state.

created_atstring nullable

RFC 3339 timestamp when the job was created.

error_codestring nullable

Machine-readable error code. Present when the job failed.

error_messagestring nullable

Human-readable error message. Present when the job failed.

estimated_time_remaining_secondsinteger nullable

Estimated seconds until the job finishes. 0 once the job is in a terminal state.

job_idstring required

Unique identifier for the indexing job, as returned by the indexing endpoint that started it.

job_typestring nullable

The indexing operation that created this job, e.g. index_s3_directory. Matches the endpoint the job was started from.

progress_messagestring nullable

Human-readable summary of the job's current progress.

started_atstring nullable

RFC 3339 timestamp when processing began. Null while the job is pending.

statusstring required

Current job status.

  • pending: queued, not yet started
  • running: in progress; see progress for the current stage
  • completed: all files indexed successfully
  • completed_with_errors: finished, but some files failed; see files and result
  • failed: the job failed; see error_code and error_message
  • cancelled: cancelled via DELETE /v2/jobs/{job_id}
  • timed_out: execution exceeded the time limit
updated_atstring nullable

RFC 3339 timestamp when the job was last updated.

custom_metadataobject nullable

Changes

No recorded changes to this endpoint across all 1 revision of this API.