Artifacts

Write one scene's atmospheric FX cues from its lines.

Writes a bounded set of atmospheric, non-text FX cues (light bursts, washes, weather, darkness) for one scene from its own lines and mood, replacing the cues it had. Synchronous. While the project's gate is closed it is refused with 409 project_precondition_failed before anything is written. Requires Idempotency-Key. Scope: artifact:publish.

post/artifacts/{artifactId}/theater-fx-cues

Request

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

Headers

Idempotency-Keystring required

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

Request body

sceneIndexinteger required

Response

The scene's new FX cues.

artifactIdstring required
sceneIndexinteger required

Changes

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