Pitch Deck

Stop the deck's render in flight (free; it gives back what was held).

Stop the deck's render in flight — its first pass, its finish, or a retake or repair still running. Nothing more is sent to a provider: its queued and running render jobs are cancelled, and a job already running stops at its next step. The writer's reservations for work that had not run are released (released, releasedCredits); every accepted take, selection, cut, finished take and master is kept (keptTakes). A shot already out at the provider is stopped and recorded on its chapter (abandoned): not charged to the writer (the provider may still bill it, at our cost), and never resumed. It lands in review with what rendered, back at draft when nothing did (approving again quotes the same shots), back in review after a stopped finish, or as it was after a stopped retake. Free: no price and nothing to confirm. With nothing rendering it answers stopped: false and changes nothing. Answers { jobId, surface, stopped, previousStatus, status, cancelledJobs, abandoned, released, releasedCredits, keptTakes, note }; read GET /pitch-decks/{jobId}/chapters after it. NOT metered and NOT confirmed. Requires Idempotency-Key. Scope: artifact:publish — the key that can start and spend on renders is the key that can stop them.

post/pitch-decks/{jobId}/cancel-render

Request

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

Headers

Idempotency-Keystring required

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

Response

What the stop did: the status it lands in, what it gave back, what it abandoned and kept.

jobIdstring required
surface'pitch_deck' | 'trailer' required
stoppedboolean required

False when nothing was rendering: nothing was changed.

previousStatusstring required
statusstring required

Where it is now: review with what rendered, draft with its plan, or as it was.

cancelledJobsinteger required

Render queue jobs cancelled (queued, retrying, or running when the stop was written).

releasedCreditsinteger required
keptTakesinteger required

Accepted takes kept, untouched.

notestring required

Read it to the writer.

Changes

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