Pitch Deck

Put the chapters in a new order.

Puts the deck's chapters in a new order: order names every chapter's chapterIndex once, in the order they will play, or move puts one chapter just after another (afterChapterIndex) or first (afterChapterIndex: null). Free: nothing renders and every chapter keeps its takes; a rendered deck's video is stitched again in the new order. Chapters filmed in one render (a scene group: a chapter whose renderedWith names another, and that chapter) move as one block, side by side in their order; an order that pulls them apart is refused (pitch_deck_scene_group_split) and a move of one of them moves the whole group. The chapters are renumbered from 0 in their new order (each answer chapter's previousChapterIndex is its key before). How a chapter hands into the next and the black after it travel with it (a black whose chapter now ends the deck is taken out and named in droppedInterludes); music and sound laid on one chapter move with it, and a score composed to the old order keeps playing but no longer lands on the chapters (score: no_longer_fits) until it is scored again, priced. A draft plan, review or complete; on a draft the changed plan is queued for plan coverage again (planCoverage). A rendered deck waits while its video is being put together or its automatic fixes are running (409 pitch_deck_reorder_assembly_running, pitch_deck_reorder_auto_fix_running). A scene group pulled apart is refused with 409 pitch_deck_state_invalid (details.refusal.code: pitch_deck_scene_group_split), as is a rendered deck whose video is being put together (pitch_deck_reorder_assembly_running) or whose automatic fixes are reviewing or fixing it (pitch_deck_reorder_auto_fix_running); nothing changes. An order that does not name every chapter once is a 400. NOT metered and NOT confirmed. Requires Idempotency-Key. Scope: story:write.

post/pitch-decks/{jobId}/chapters/reorder

Request

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

Headers

Idempotency-Keystring required

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

Request body

orderinteger[]

Every chapter's chapterIndex once, in the order they will play. 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.

Response

The chapters in their new order, and what the move did to the cut.

successboolean required
movedboolean required

False when the deck was already in that order: nothing was saved and nothing is stitched.

chapterCountinteger required
restitchingboolean required

A rendered deck that moved: its video is stitched again in the new order (free; nothing renders).

score'no_longer_fits' | 'null' nullable required

no_longer_fits when a score composed to the cut is laid: it still plays under the whole deck but no longer lands on the chapters until it is scored again (priced).

bellLaneboolean required

The deck has a bell lane: it still strikes the title sequence's beat, laid again with the new order (free).

messagestring required

What happened, in one sentence to show the writer.

planCoverage'queued' | 'current' | 'failed' | 'null' nullable

On a draft plan: the changed plan's plan coverage (queued for the latest edit). Null in review or complete.

edited'draft_plan' | 'rendered_deck'

Which version of the deck the edit changed: draft_plan (a draft deck — nothing has rendered) or rendered_deck (a deck in review or complete). Tell the writer which one changed.

jobIdstring

The deck that changed.

status'draft' | 'review' | 'complete'

The deck's status, unchanged by a reorder.

Changes

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