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.
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
Customer-generated stable identifier for safe retries of idempotent POST requests.
Request body
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).
Changes
No recorded changes to this operation across all 2 revisions of this API.