Pitch Deck

Direct how a deck's text looks and moves (a chapter's caption, the title sequence's words, or the closing sequence's cards).

Say in plain words how one chapter's on-screen text should move — "type it out letter by letter, then draw an underline beneath it" — and it is compiled into the bounded motion spec that chapter's text layer executes. NOT metered and NOT confirmed: it costs no credits and renders nothing, and re-directing REPLACES the treatment rather than adding to it, so there is nothing a confirmation would protect. Your own words are saved beside the compiled spec, so the next direction is not authored blind. Nothing MOVES on screen until the text layer is re-rendered with storyboard/regenerate-text, which IS metered. A chapter with nothing to move is refused with a 409 before anything is compiled — a chapter that is footage only, or one whose caption is still empty — and the refusal names the fix. THE TITLE SEQUENCE'S WORDS: send titleElement (title, epigraph, sourceCredit, nameSupers) instead of chapterIndex to direct how one looks and moves ("KARAMAZOV huge, blood red, the ends cut off by the frame"), or clear: true to put it back in the sequence's own type; the title sequence is drawn by the master, so a rendered deck's master is stitched again (free, reassembling) and no chapter renders. A title sequence with no such words (no epigraph yet, name supers off) is refused with a 409. THE CLOSING SEQUENCE'S CARDS: send closingElement (quote, comingSoon, productionCredit) to direct one the same way, or clear: true to put it back in the opening's look; a closing with no quote yet refuses quote with a 409. Requires Idempotency-Key. Scope: story:write.

post/pitch-decks/{jobId}/storyboard/direct-text-motion

Request

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

Headers

Idempotency-Keystring required

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

Request body

chapterIndexinteger

The chapter whose on-screen text should move. 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.

titleElement'title' | 'epigraph' | 'sourceCredit' | 'nameSupers'

Instead of a chapter: one of the title sequence's words — title, epigraph (with where it is from), sourceCredit, or nameSupers (every super alike).

closingElement'quote' | 'comingSoon' | 'productionCredit'

Instead of a chapter: one of the closing sequence's cards — quote (with where it is from), comingSoon, or productionCredit.

directionstring

How the text should look and move, in the writer's own words — e.g. "type it out letter by letter, then draw an underline beneath it", or "KARAMAZOV huge, blood red, a stark sans, the ends cut off by the frame". Required unless clear is true.

cleartrue

With titleElement: put it back in the title sequence's own type. With closingElement: put the card back in the opening's look.

Response

The direction now on the chapter (plus a link to watch it), or on the title sequence's word (with the sequence as every read shows it).

successboolean required
chapterIndexinteger

The chapter directed (a chapter direction).

titleElement'title' | 'epigraph' | 'sourceCredit' | 'nameSupers'

The title sequence word directed (a title direction).

directionstring nullable required

The writer's own words, saved beside the compiled spec so the next direction is not authored blind; null when a title sequence word was put back in its own type. A title direction is read back from the stored deck before it is reported (one another plan edit replaced is refused with 409 pitch_deck_state_invalid).

lookstring nullable

What the master draws for a directed title sequence word, read from the stored spec rather than the writer's sentence: the face, size and colour of its words, or that the direction is a background only under its own type. Null when it was put back in its own type.

previewUrlstring

Shareable link to watch this chapter's current render — so seeing what the direction did costs nothing (a chapter direction).

closingElement'quote' | 'comingSoon' | 'productionCredit'

The closing card directed (a closing direction).

reassemblingboolean

True when the deck's master is stitched again with it (a rendered deck; free — no chapter renders).

Changes

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