Artifacts

Change one scene's theater.

Sets one scene's text reveal, look (visualStyle), transition, backdrop prompt and media, and atmospheric FX cues (a list replaces the scene's cues; [] clears them). Fields left out are kept. The same save as the Table Read page's per-scene controls and Slug's update_scene_theater. Free: renders nothing. Requires Idempotency-Key. Scope: artifact:publish.

post/artifacts/{artifactId}/theater-scene

Request

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

Headers

Idempotency-Keystring required

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

Request body

sceneIndexinteger required
textRevealStyle'fade' | 'drift' | 'spotlight'
summarystring

A short note on the scene's theater treatment.

backdropPromptstring

The backdrop prompt: the setting only, no characters, no on-screen text.

mediaPreference'image' | 'video'
transitionType'crossfade' | 'spotlight' | 'curtain' | 'drift' | 'hard-cut'
transitionDurationMsnumber
transitionPromptstring

How the scene arrives from the one before it.

Response

The scene's theater as it now stands.

artifactIdstring required

Changes

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