Artifacts

Edit a soundscape bed or region.

One edit by op: update_bed tunes a scene's bed (label, start/end offsets in lines, level, fades, loop or stretch); add_region adds a custom region over a range of lines (optionally with library audio, assetId); update_region moves or re-levels one; attach gives a bed or region library audio (assetId, from GET /library/audio); remove takes a bed's sound off or deletes a region. A region may not overlap another soundscape. Free; a finalized MP3/MP4 is marked stale. Requires Idempotency-Key. Scope: artifact:publish.

post/artifacts/{artifactId}/soundscapes

Request

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

Headers

Idempotency-Keystring required

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

Request body

op'update_bed' | 'add_region' | 'update_region' | 'attach' | 'remove' required
target'scene_bed' | 'region'
sceneIndexinteger
regionIdstring
assetIdstring

A library audio asset (GET /library/audio).

startEntryinteger
endEntryinteger
startEntryOffsetinteger

A scene bed: lines after the scene's first line it starts.

endEntryOffsetinteger

A scene bed: lines before the scene's last line it ends.

labelstring
volumenumber
fadeInMsinteger
fadeOutMsinteger
playMode'loop' | 'stretch'

Response

The edit and the bed or region as it now stands.

artifactIdstring required
op'update_bed' | 'add_region' | 'update_region' | 'attach' | 'remove' required
target'scene_bed' | 'region' required
idstring required

Changes

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