Sign in

v3

latestOpenAPI 3.1.02026-08-01101194245.5 KB
jobs

Get Jobs

Get jobs using RQ Groups-based querying.

Maps document IDs to RQ Groups for efficient job status retrieval. For reference-level queries, searches over documents linked to the reference.

get/jobs/

Query parameters

document_idstring uuid nullable

Filter by document ID

Filter by document ID

referencestring nullable

Filter by document reference

Filter by document reference

group_idstring nullable

Filter by RQ Group ID

Filter by RQ Group ID

Response

Successful Response

idstring required

Job ID

status'created' | 'queued' | 'finished' | 'failed' | 'started' | 'deferred' | 'scheduled' | 'stopped' | 'canceled' required

The Status of Job within its lifecycle at any given time.

document_idstring uuid nullable

Document ID associated with the job

referencestring nullable

Document reference for tracking

workspace_idstring uuid nullable

Workspace ID

workflow_stepstring nullable

Current workflow step

progressnumber nullable

Job progress (0.0-1.0)

errorstring nullable

Error message if job failed

resultobject nullable

Job result data

metaobject nullable

Additional job metadata

started_atstring date-time nullable

When job was started

completed_atstring date-time nullable

When job was completed

group_idstring nullable

RQ Group ID for the workflow

group_statusstring nullable

Status of the entire RQ Group

group_progressnumber nullable

Overall progress of the group (0.0-1.0)

total_jobsinteger nullable

Total number of jobs in the group

completed_jobsinteger nullable

Number of completed jobs in the group

failed_jobsinteger nullable

Number of failed jobs in the group

running_jobsinteger nullable

Number of running jobs in the group