Refine one pitch deck chapter.
Edits one chapter's plan while the deck is a draft plan, in review or complete: its title (title, plan words that never make a take stale; never empty), what it delivers (storyBeat), what it shows on screen (visualPlan), its shot size (shotType, which must name a scale on the shot ladder — establishing, wide, medium or close, the scale word deciding, so "medium close" is a medium; a shot type that names none is refused with a 400; the render is told it, so it stales a rendered chapter's takes; '' clears it), where it is set (location, a canonical location key; null clears it), the camera motion and the hand-off into the next chapter, its words (narration and who speaks it, caption, text mode and treatment), composition, duration, who is in the picture (visibleCharacters, the named characters on camera, each with an identity reference; featuredCharacter), the stage of the deck's intent it serves (arcStage, advancesQuestion — plan words that never make a take stale), whether it is a rapid intercut run (montage — brief shots cut tight; fed to the render, so it stales the takes), and its continuity — propContinuity, wardrobeContinuity and screenDirection, which the render is told ("Props: …"), so a prop the writer is steering away from must leave them too; and continuityNotes, which it is never told ('' clears any of them). imagePrompt and castReferenceMode are gone — a chapter has no still, and its cast reaches the render as body figures — and either is refused by name (400). Free — it saves the plan. On a DRAFT plan nothing has rendered, so nothing goes stale: the next plan approval recompiles just this chapter, and the changed plan is queued for plan coverage again (planCoverage: queued for the latest edit — one run per burst of edits, started once the plan has been left alone for three minutes; the plan approval starts it at once and waits for its score). This is how a chapter the plan approval refused (pitch_deck_render_blocked, for example a sentence too long for one render) is fixed: refine it, then price the approval again. In review or complete an edit to what the chapter films marks its takes out of date (they stay playable) and a caption edit marks only its text layer; render the chapter again with chapters/render-clip (priced). chapterIndex: 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. Returns needsRerender, chapterIndex, chapterNumber, planCoverage, shotLadderRung (when it set a shot type: the rung it landed on), edited (which version changed: draft_plan or rendered_deck — tell the writer which), the deck's jobId and status, and previewUrl. Provide at least one editable field. 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}/chapters/refine
- Auth: HTTP bearer
Headers
Customer-generated stable identifier for safe retries of idempotent POST requests.
Request body
Response
The saved chapter edit + a shareable chapter preview link.
Changes
No recorded changes to this operation across all 2 revisions of this API.