Job Management

Get a job

One job as it stands: its status, the item counts, what ran (op, preset and version, model, steps) and, per item, the output — resultAssetId, or output for an analyze — or, for a failed item, errorCode and retryable. The first 100 items ride inline and itemsTruncated says when there are more (GET /api/v1/jobs/{id}/items pages the rest). actualCredits is what the job was charged; it is set when the job settles.

wait turns the read into a long-poll: the answer is held until the job is terminal or the window closes, and the job as it stands comes back either way — read status. It is how a 202 from a waited submit is picked up.

A job record lives as long as the assets it made: at expiresAt it is swept, and a read after that is 404.

USE THIS WHEN:

  • Reading what a job produced, or why an item failed
  • Waiting for a job to finish without writing a poll loop (?wait=)

DO NOT USE WHEN:

  • Listing jobs → use GET /api/v1/jobs
  • You only want the assets it made → GET /api/v1/assets?jobId={id}
get/api/v1/jobs/{id}

Request

  • Base URL: https://api.imagestep.dev
  • URL: https://api.imagestep.dev/api/v1/jobs/{id}
  • Auth: API key in header Authorization

Path parameters

idstring required

The job's id, job_…

Query parameters

waitinteger

Long-poll: hold the response until the job is terminal, for at most this many seconds (at most 60; a larger value is clamped). The job as it stands comes back either way — read status. Any job, batches included. More than 8 waits open on one account is 429 rate_limited (details.reason account_concurrency) with Retry-After; a full node is 503 provider_unavailable. Both are retryable.

Response

The job — terminal or not; read status

Changes

No recorded changes to this operation across all 1 revision of this API.