Trailer

Read how one beat's words play.

Changed on

Free and read-only: the spec the trailer's master draws for the beat's words (compiled from their style, or the beat's direction), the beat's length, the window a preview plays (the beat and a second of each neighbour, in seconds of the master), when the words are on screen (words), notes for what they could not keep as asked, and a shareable previewUrl. A beat with no words is refused (409). The 480p MP4 of the window is POST …/text-preview/render. Scope: story:read.

get/trailers/{jobId}/beats/{beatIndex}/text-preview

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/trailers/{jobId}/beats/{beatIndex}/text-preview
  • Auth: HTTP bearer

Response

The beat's words as the master draws them.

beatIndexinteger required
beatNumberinteger required
style'statement' | 'thought' | 'typed' | 'reveal' | 'label' | 'stat' | 'directed' required
specobject required

The motion-text spec the master draws (compiled from the style, or the beat's direction).

durationSecondsnumber required
notesstring[] required
previewUrlstring nullable required

A shareable link to watch the beat.

Changes