Get Job Status - Hedra

GET

/

jobs

/

{job_id}

/

status

Get Job Status

curl --request GET \
  --url https://api.hedra.com/v3/jobs/{job_id}/status \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.hedra.com/v3/jobs/{job_id}/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hedra.com/v3/jobs/{job_id}/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hedra.com/v3/jobs/{job_id}/status"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hedra.com/v3/jobs/{job_id}/status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "job_id": "<string>",
  "progress": 0.5,
  "estimated_completion_at": "2023-11-07T05:31:56Z",
  "logs": [
    {
      "id": 123,
      "timestamp": "2023-11-07T05:31:56Z",
      "message": "<string>",
      "data": {}
    }
  ],
  "logs_next_cursor": "<string>"
}

Authorizations

Authorization

string

header

required

Primary scheme: Authorization: Key <key_id>:<secret>.

Path Parameters

job_id

string

required

Query Parameters

logs_after

string | null

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

The lightweight poll envelope, also the SSE status frame and the MCP progress notification payload.

The two log fields are poll-only by construction, like cost on the result envelope: they are populated when — and only when — a GET /v3/jobs/{job_id}/status caller supplies a logs_after cursor, and they exclude when None, so the frame the stream transports build from a Redis payload with no DB session is byte-identical to a log-free envelope. That was ENG-9693's reason for having no logs field at all; the stream now carries lifecycle rows as their own event: log frames instead of inside this one (ENG-9694), and MCP progress notifications stay status-only.

job_id

string

required

status

enum<string>

required

The four states a job can be in.

Available options:

IN_QUEUE,

IN_PROGRESS,

COMPLETED,

FAILED

progress

number

Fraction of the job completed, from 0 to 1 (not a percentage). Null when the job has not reported progress yet.

Required range: 0 <= x <= 1

estimated_completion_at

string<date-time> | null

logs

JobLogItem · object[] | null

Lifecycle events newer than the logs_after cursor, oldest first. Present only when logs_after is supplied; absent from SSE status frames and MCP progress notifications.

Show child attributes

logs_next_cursor

string | null

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

⌘I

Get Job Status

curl --request GET \
  --url https://api.hedra.com/v3/jobs/{job_id}/status \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.hedra.com/v3/jobs/{job_id}/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hedra.com/v3/jobs/{job_id}/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hedra.com/v3/jobs/{job_id}/status"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hedra.com/v3/jobs/{job_id}/status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "job_id": "<string>",
  "progress": 0.5,
  "estimated_completion_at": "2023-11-07T05:31:56Z",
  "logs": [
    {
      "id": 123,
      "timestamp": "2023-11-07T05:31:56Z",
      "message": "<string>",
      "data": {}
    }
  ],
  "logs_next_cursor": "<string>"
}