Artifacts

Change the table read's theater presentation.

A partial update of the whole read's presentation: keys left out are untouched and theme objects merge field by field. applyStyleSetId applies a built-in or saved style set and marks it active (applied first, then any theme field beside it); styleSets replaces the saved custom sets; nounImagery.displayMode sets how spoken-noun images appear. The scene soundtrack's master switch is soundtrackEnabled on POST /artifacts/{artifactId}/music. The same save the Table Read page's theater settings make. Free: renders nothing. Requires Idempotency-Key. Scope: artifact:publish.

post/artifacts/{artifactId}/theater

Request

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

Headers

Idempotency-Keystring required

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

Request body

theaterModeDefaultboolean

Open the read in theater mode by default.

backgroundAnimationEnabledboolean

Moving backdrops on or off.

adaptiveStyleEnabledboolean

Scene visuals (each scene's own motifs, overlay and accents) on or off.

applyStyleSetIdstring

Apply a built-in or saved style set (GET lists them) and mark it active.

Response

The presentation as it now stands.

artifactIdstring required
presentationobject required

The whole read's presentation as it now stands.

Changes

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