Pitch Deck

Price, then render, one chapter's text / motion-graphic layer.

Renders one chapter's on-screen text / motion-graphic layer with its current caption + treatment: a text-only chapter on its own, a text-over-footage chapter composited over its cut. Metered — charges a single per-text credit (returned as credits). Poll GET /pitch-decks/{jobId}/chapters. TWO CALLS, PRICE FIRST: sent WITHOUT confirmed it prices the render and reserves nothing (quotedOnly: true); sent again with confirmed: true it reserves the single credit line and queues the render. The flag is optional rather than a required true because a field that must be true to validate cannot separate a confirmed call from an unconfirmed one, and it would force the price to be announced after the money moved. Preconditions run above the price: a footage-only chapter carries no on-screen text and is refused with no quote at all. Review or complete only. A confirmed call returns reviewUrl + a shareable per-chapter previewUrl. Requires Idempotency-Key. Scope: artifact:publish — a read-only key can neither spend nor ask what spending would cost.

post/pitch-decks/{jobId}/storyboard/regenerate-text

Request

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

Headers

Idempotency-Keystring required

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

Request body

chapterIndexinteger required

The chapter whose text layer to render. The chapter's chapterIndex, exactly as the chapters read returns it: a key, not a position — a plan may key its chapters from 0 or from 1. A person's "chapter 2" is the chapter whose chapterNumber is 2; pass that chapter's chapterIndex.

confirmedboolean

Omit (or false) to get the price WITHOUT spending anything — nothing is reserved and nothing is queued. Send true only after the writer has seen that price and said go. It is optional rather than a required true because a field that must be true to validate cannot separate a confirmed call from an unconfirmed one.

Response

The price (no confirmed) or the queued render, plus a shareable chapter preview link.

quotedOnlyboolean required

True when this was a price and NOTHING was spent; false when the render was reserved and queued.

chapterIndexinteger
previewUrlstring

Shareable link to watch this chapter's current cut.

reviewUrlstring nullable

Logged-in browser link to the deck. Present on a confirmed call.

creditsnumber

Credits charged for this render, or — when quotedOnly is true — what a confirmed call would charge.

costLabelstring nullable

The rate-card line the price came from (quote only).

balanceAfterinteger

Quote only. Studio Credits the writer would have left once this is spent: the balance available now (as Billing shows it) minus the price. Negative means they are that many short.

sufficientboolean

Quote only. True when the available balance covers the price. False means the writer must top up first (the note names the Billing link) — do not confirm; the reserve would refuse.

notestring

The price in the writer's own words, what it would leave (or how short they are, with the top-up link), and how to proceed (quote only).

Changes

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