Job Management

Resume incomplete items in a job

Retries what did not finish: a new job over the FAILED and CANCELLED items of a FAILED or CANCELLED job, with the original's configuration — the same op, model, prompt and parameters, the same preset at the version the original ran, or the same inline steps and subjects. Only the incomplete items are retried (a variant set may repeat a few that had completed — deterministic work, priced like any other run).

  • The new job is an ordinary submit: it is priced, checked and charged like one, so it can be refused like one (402, 422).
  • A chain item restarts on the segment it failed on (failedStep), from the image the last segment it finished made; the segments it already paid for are not paid again.
  • A source asset deleted since the original ran drops its item from the retry; when none is left the answer is 404 asset_not_found.
  • The new job points back with parentJobId, carries rootJobId — the first attempt's id, the same on every resume and on the first attempt itself — and advances attemptNumber by 1; GET /api/v1/jobs?rootJobId= lists every attempt. Only the latest attempt can be resumed, and only a few times (details.job.maxResumes).

Whether a resume can help at all is on the job: retryable: true means at least one failed item failed for a reason that may pass.

USE THIS WHEN:

  • Retrying only the failed items of a partially-successful job without resubmitting the whole batch

DO NOT USE WHEN:

  • Submitting a fresh job → use POST /api/v1/jobs
  • Every failed item says retryable: false — the same input fails the same way
post/api/v1/jobs/{id}/resume

Request

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

Path parameters

idstring required

The id of the job to retry, job_…

Headers

Idempotency-Keystring

Optional. A client-generated unique key (typically a UUID). Same key + the same request (method, path, query string and body) replays the first response verbatim with Idempotency-Replayed: true, without executing again. Same key + a different one returns 409 idempotency_key_reuse. A repeat that arrives while the first is still running returns 409 request_in_progress, which is retryable. Keys are retained 24 hours. At most 255 characters; a longer one is a 400 invalid_param with param: "Idempotency-Key".

Response

The new attempt, created

Changes

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