Artifacts

Manage line-level sound-effect cues for a table read artifact.

Mutates timed sound-effect cues on the live read backing a table_read artifact. Use { op: "add", entryIndex, label, prompt, volume?, triggerOffset?, offsetMs?, generatedDurationS?, enabled? } to add a cue. Use { op: "update", id, ...fields } to retime, rename, mute, or regenerate a cue. Use { op: "remove", id } to remove a cue. Adding a cue, or updating one with regenerate: true, generates its audio: while the project's gate is closed it is refused with 409 project_precondition_failed before anything is generated or saved. A retime, rename, mute or removal generates nothing and stays open. This does not create a new artifact revision and does not change share URLs. Scope: artifact:publish. Idempotency-Key is required.

post/artifacts/{artifactId}/sfx

Request

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

Headers

Idempotency-Keystring required

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

Request body

op'add' | 'update' | 'remove'
entryIndexinteger

Dialogue entry index for add or update operations.

labelstring
promptstring
volumenumber
triggerOffset'before' | 'with' | 'after'
offsetMsinteger

Millisecond timing nudge relative to the cue trigger.

generatedDurationSnumber

Generated cue duration in seconds.

enabledboolean

false mutes/excludes the cue without deleting it.

regenerateboolean

For update operations, regenerate cue audio from the revised prompt.

idstring

Cue id for update or remove operations.

Response

SFX mutation result.

artifactIdstring
removedboolean
idstring
labelstring

Changes

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