HEhedra-labs
Jobs

Get Job Status

Changed on
get/jobs/{job_id}/status

Request

  • Base URL
    https://api.hedra.com/v3
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Path parameters

job_idstring required

The job's id (job_<uuid>).

Query parameters

logs_afterstring nullable

Tail this job's lifecycle events incrementally: returns only events newer than this cursor, plus logs_next_cursor to send on the next poll. Pass start to begin from the job's first event. Omit it and the response carries no events at all — the default polling shape is unchanged.

Response

Successful Response

job_idstring required

The job this status describes.

status'IN_QUEUE' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' required

The four states a job can be in.

progressnumber nullable

Estimated fraction of the job completed, from 0 to 1 (not a percentage). While estimated_completion_at is non-null, this value is computed from the time since submission and that estimate, so it is only as accurate as the estimate, and it stays below 1. While an IN_QUEUE or IN_PROGRESS job's estimated_completion_at is null, GET /v3/jobs/{job_id}/status reports 0. A COMPLETED job reports 1. A FAILED job's value can be anything from 0 to 1 and does not show how far the job got.

estimated_completion_atstring date-time nullable

ISO-8601 instant this job is estimated to finish. A job can finish well before or after it. The estimate can change while the job runs, so read it from each poll. Null once the job is COMPLETED or FAILED, and while no estimate is available. The submit response also includes it; GET /v3/jobs/{job_id} and GET /v3/jobs do not.

logs_next_cursorstring nullable

Cursor to send as logs_after on the next poll. Absent when this poll delivered no new events — keep using the cursor you sent.

Changes