Artifacts

Add or refine a motion-graphics beat in a theater scene.

Authors or refines a single MOTION BEAT (kinetic on-screen text, a lower-third, or a title card) anchored to one spoken line and baked into the durable theater video. Returns shareUrl — a watchable link to the enhanced theater video. Requires Idempotency-Key. Scope: artifact:publish.

post/artifacts/{artifactId}/theater-motion

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/artifacts/{artifactId}/theater-motion
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

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

Request body

sceneIndexinteger required

Zero-based scene index.

entryIndexinteger required

Zero-based script entry (spoken line) this beat occupies.

compositionKind'motion-only' | 'motion-over-clip' | 'performance-motion-overlay' required

How the motion graphic composites.

captionTextstring

On-screen copy the motion layer renders.

directionstring

Natural-language motion direction.

durationSecondsnumber

Motion timeline length in seconds.

backgroundClipPromptstring

Look for the background clip (for a motion-over-clip beat; generated separately).

Response

The motion beat + a shareable theater video link.

artifactIdstring required
shareUrlstring

Watchable link to the enhanced theater video.

Changes

No recorded changes to this operation across all 1 revision of this API.