Get Job - Hedra

GET

/

jobs

/

{job_id}

curl "https://api.hedra.com/v3/jobs/{job_id}" \
  -H "Authorization: Bearer $HEDRA_API_KEY"

{
  "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>",
        "billing": {
          "balance": 123,
          "funding_url": "<string>",
          "required": 123,
          "currency": "USD"
        }
      }
    }
  ],
  "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>",
    "billing": {
      "balance": 123,
      "funding_url": "<string>",
      "required": 123,
      "currency": "USD"
    }
  },
  "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

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

Response

Successful Response

job_id

string

required

The job this envelope describes.

model

string

required

The resolved model id this job ran on.

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[]

The job's outputs — always an array, even for a single output; empty until the job completes.

Show child attributes

metrics

Metrics · object | null

Timing for this job; present on completed jobs only.

Show child attributes

error

ErrorEnvelope · object | null

Why the job failed; null unless status is FAILED.

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.

⌘I

curl "https://api.hedra.com/v3/jobs/{job_id}" \
  -H "Authorization: Bearer $HEDRA_API_KEY"

{
  "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>",
        "billing": {
          "balance": 123,
          "funding_url": "<string>",
          "required": 123,
          "currency": "USD"
        }
      }
    }
  ],
  "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>",
    "billing": {
      "balance": 123,
      "funding_url": "<string>",
      "required": 123,
      "currency": "USD"
    }
  },
  "logs": [
    {
      "id": 123,
      "timestamp": "2023-11-07T05:31:56Z",
      "message": "<string>",
      "data": {}
    }
  ],
  "cost": 123,
  "currency": "<string>"
}