Trailer

Place a sound effect on one beat.

One endpoint, selected by action: add generates a new cue from a prompt, apply-library places a track already in My Library (no generation, and the only way a recurring motif sounds IDENTICAL every time), update moves, relevels or disables a placed cue, remove deletes it. Offsets are measured from the beat's own start. Generating — add — waits for the project's gate: while it is closed the call is refused with 409 project_precondition_failed and nothing is generated or placed; apply-library, update and remove generate nothing and stay open. Requires Idempotency-Key. Scope: story:write.

post/trailers/{jobId}/storyboard/sfx

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/trailers/{jobId}/storyboard/sfx
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

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

Request body

action'add' | 'update' | 'remove' | 'apply-library' required
sceneIndexinteger required

Zero-based index of the beat.

Response

The placed cue, plus a shareable per-beat preview link.

object required

Changes

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