Pitch Deck

Add a blank chapter.

Adds a new blank chapter: atIndex is the position it takes (0 = first — a position, not a key), afterChapterIndex puts it just after the chapter with that chapterIndex (its key from the chapters read), and omitting both appends it. NOT metered: it renders nothing — the new chapter has no footage until it is refined and rendered (chapters/render-clip, priced) — and every other chapter keeps its takes. A complete deck goes back to review. A draft plan, review or complete. On a draft plan nothing has rendered: the plan is renumbered (its black interludes follow their chapters) and the changed plan is queued for plan coverage again (planCoverage). Requires Idempotency-Key. Scope: story:write.

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

Request

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

Headers

Idempotency-Keystring required

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

Request body

atIndexinteger

The POSITION the new chapter takes (0 = first) — a position, not a chapter key.

afterChapterIndexinteger

Insert just after this chapter. 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

Where the new chapter landed.

successboolean required
insertedChapterIndexinteger required

The new chapter's key. The chapters are renumbered from 0 on insert, so it is chapter insertedChapterIndex + 1 of the deck.

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

On a draft plan: the changed plan's plan coverage (queued for the latest edit, current, or failed — the approval says what is missing). 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 after the edit (a complete deck goes back to review when a chapter is added).

Changes

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