Jobs

Cancel a story job and release its reserved credits.

Valid only while the job is PENDING or RESERVED, or FAILED before it ever started (a refused reservation or a lost enqueue) — canceling that one means it can no longer be resumed. A FAILED job that had started generating is refused. Releases any reserved (not-yet-settled) credit line items. Requires Idempotency-Key; canceling an already-canceled job is a no-op.

post/story-jobs/{jobId}/cancel

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/story-jobs/{jobId}/cancel
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Customer-generated stable identifier for safe retries of idempotent POST requests.

Response

Canceled job envelope.

Changes

No recorded changes to this operation across all 2 revisions of this API.