Get Job - Hedra

GET

jobs

{job_id}

Get Job

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

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

fetch('https://api.hedra.com/v3/jobs/{job_id}', 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}",
  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}"

	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}")

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>",
  "model": "<string>",
  "quality": "<string>",
  "prompt": "<string>",
  "outputs": [
    {
      "status": "COMPLETED",
      "asset_id": "<string>",
      "url": "<string>",
      "content_type": "<string>",
      "width": 123,
      "height": 123,
      "duration_ms": 123,
      "fps": 123,
      "error": {
        "message": "<string>",
        "retryable": false,
        "retry_after": 123,
        "param": "<string>",
        "details": [
          {
            "field": "<string>",
            "message": "<string>",
            "reason": "<string>",
            "allowed": [
              "<string>"
            ]
          }
        ],
        "replaced_by": "<string>"
      }
    }
  ],
  "metrics": {
    "processing_time_ms": 123
  },
  "error": {
    "message": "<string>",
    "retryable": false,
    "retry_after": 123,
    "param": "<string>",
    "details": [
      {
        "field": "<string>",
        "message": "<string>",
        "reason": "<string>",
        "allowed": [
          "<string>"
        ]
      }
    ],
    "replaced_by": "<string>"
  },
  "logs": [
    {
      "id": 123,
      "timestamp": "2023-11-07T05:31:56Z",
      "message": "<string>",
      "data": {}
    }
  ],
  "cost": 123,
  "currency": "<string>"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

job_id

string

required

Response

Successful Response

job_id

string

required

model

string

required

status

enum<string>

required

The four states a job can be in.

Available options:

IN_QUEUE,

IN_PROGRESS,

COMPLETED,

FAILED

quality

string | null

The quality level this job ran at; present only for models that offer quality levels.

prompt

string | null

The prompt this job ran with. When enhance_prompt was set, this is the rewritten prompt the model received rather than the one submitted. Absent on models that take no prompt.

outputs

OutputItem · object[]

Show child attributes

metrics

Metrics · object | null

Timing for this job; present on completed jobs only.

Show child attributes

error

ErrorEnvelope · object | null

Show child attributes

logs

JobLogItem · object[] | null

The most recent lifecycle events for this job, oldest first. Capped; GET /v3/jobs/{job_id}/logs serves the full paginated history. Absent from webhook payloads.

Show child attributes

cost

number | null

Net cost of this job; 0 when fully refunded; absent until charged. Absent from webhook payloads.

currency

string | null

ISO-4217 currency code for cost. Present exactly when cost is.

Get Job Status

⌘I

Get Job

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

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

fetch('https://api.hedra.com/v3/jobs/{job_id}', 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}",
  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}"

	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}")

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>",
  "model": "<string>",
  "quality": "<string>",
  "prompt": "<string>",
  "outputs": [
    {
      "status": "COMPLETED",
      "asset_id": "<string>",
      "url": "<string>",
      "content_type": "<string>",
      "width": 123,
      "height": 123,
      "duration_ms": 123,
      "fps": 123,
      "error": {
        "message": "<string>",
        "retryable": false,
        "retry_after": 123,
        "param": "<string>",
        "details": [
          {
            "field": "<string>",
            "message": "<string>",
            "reason": "<string>",
            "allowed": [
              "<string>"
            ]
          }
        ],
        "replaced_by": "<string>"
      }
    }
  ],
  "metrics": {
    "processing_time_ms": 123
  },
  "error": {
    "message": "<string>",
    "retryable": false,
    "retry_after": 123,
    "param": "<string>",
    "details": [
      {
        "field": "<string>",
        "message": "<string>",
        "reason": "<string>",
        "allowed": [
          "<string>"
        ]
      }
    ],
    "replaced_by": "<string>"
  },
  "logs": [
    {
      "id": 123,
      "timestamp": "2023-11-07T05:31:56Z",
      "message": "<string>",
      "data": {}
    }
  ],
  "cost": 123,
  "currency": "<string>"
}