Pitch Deck

Set the deck's visual grammar.

Replaces the deck's visual grammar (the chapters read returns the current one as visualGrammar). The visual grammar is the deck's one camera language across every chapter: how its world is lit and framed, how the camera moves or holds, and how chapters hand off. It is plan words: plan coverage judges every chapter against it, and nothing rendered reads it, so changing it never makes a take out of date. An unknown field is refused by name (400). Free. On a draft plan the changed plan is queued for plan coverage again (planCoverage); in review or complete it is saved on the plan and nothing else happens. The answer's edited says which version changed. Refused while a render or finish pass runs (409). Requires Idempotency-Key. Scope: story:write.

post/pitch-decks/{jobId}/visual-grammar

Request

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

Headers

Idempotency-Keystring required

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

Request body

visualGrammarstring required

The deck's whole visual grammar, as it should read (spacing is collapsed). The visual grammar is the deck's one camera language across every chapter: how its world is lit and framed, how the camera moves or holds, and how chapters hand off. It is plan words: plan coverage judges every chapter against it, and nothing rendered reads it, so changing it never makes a take out of date.

Response

The deck's visual grammar, as saved.

successtrue required
jobIdstring required
status'draft' | 'review' | 'complete' required
edited'draft_plan' | 'rendered_deck' required

Which version changed: the draft plan, or a rendered deck's plan. Tell the writer which one.

visualGrammarstring required

The visual grammar the stored plan now holds (read back).

changedboolean required

False when the deck already said exactly this: nothing was written and nothing queued.

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

On a draft: the changed plan's coverage (queued for the latest edit). Null otherwise.

Changes

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