Reference

Jobs API

Create, poll, cancel, retry.

The /v1/jobs surface is the workhorse endpoint:

  • POST /v1/jobs β€” create. Body: type, model, input.
  • GET /v1/jobs?limit=&cursor=&status=&type= β€” list.
  • GET /v1/jobs/{id} β€” detail, includes assets.
  • GET /v1/jobs/{id}/stream β€” Server-Sent Events feed.
  • GET /v1/jobs/{id}/events β€” full event log.
  • POST /v1/jobs/{id}/cancel β€” cancel pending/running.
  • POST /v1/jobs/{id}/retry β€” re-submit a failed job with same input.

The SSE stream emits progress events as the job transitions through queued β†’ routed β†’ credits_held β†’ running β†’ submitting β†’ submitted β†’ mirroring β†’ assets_registered β†’ done.done and error close the stream.

Last updated 2026-04-17Needs more detail? β†’