Add a trailer beat or a text card at a seam.
Changed onAdds a new beat: atIndex is the position it takes, afterBeatIndex puts it just after that beat, and omitting both appends it to the end. NOT metered. With text ({ words, style? }) the beat is a TEXT CARD: its words in their style (absent: a statement), running as long as they take to read (2.5–6 s; words that cannot be read in 6 s are refused with the most the style carries); two text cards never sit side by side; a card between two shots stales neither; on a rendered trailer the master is stitched again with it, free (masterRebuild: restitching); the answer's text says how it plays. Without text the beat arrives blank, with no footage; direct it with beats/refine, then render it with beats/render-clip (priced). Returns insertedBeatIndex, the new beatCount, staleBeats and captureOnly. ON A TRAILER WITH NO SCREENPLAY (captureOnly: true) the beat is never rendered: make it a capture beat (compositionKind: 'capture' with a captureId) with beats/refine, or add a text card instead (text); approving or finishing the trailer is refused with trailer_capture_only, naming the beat, while it is blank. A trailer with no screenplay (POST /story-projects/{projectId}/trailers) is edited this way on its draft too, since no planner draws its beats; a screenplay trailer's draft keeps the plan its planner drew. Requires Idempotency-Key. Scope: story:write.
Request
- Base URL: https://docs.sleeperhit.studio/api/v1
- URL: https://docs.sleeperhit.studio/api/v1/trailers/{jobId}/storyboard/add-beat
- Auth: HTTP bearer
Headers
Customer-generated stable identifier for safe retries of idempotent POST requests.
Request body
Response
The new beat's position + the beats now out of date.
Changes
- info
added the new optional request property
- info
added the optional property
to the response with the status
- info