Library

List your reusable My-Library audio.

Lists one page of the durable music, sound effects, and soundscapes owned by the caller, ONE ROW PER SOUND, newest first: every take of the same kind and name (case and spacing aside) is one row — its newest take, whose id is the assetId to apply — with takeCount and episodeCount. Filter by kind, search names/prompts with query, or keep one story project's sounds with projectId. total is how many sounds match across every page; pass nextCursor back as cursor (with the same filters) for the next page (null on the last). Scope: story:read.

get/library/audio

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/library/audio
  • Auth: HTTP bearer

Query parameters

kind'music' | 'sfx' | 'soundscape'
querystring

Words matched against each take's name or prompt, case-insensitively.

projectIdstring

Keep only sounds made for this story project's episodes.

limitinteger

Sounds per page (default 48, max 100).

cursorstring

Opaque cursor: the nextCursor of the previous page.

Response

Your reusable My-Library audio.

nextCursorstring nullable required

Pass as cursor (with the same filters) for the next page; null on the last page.

totalinteger required

How many sounds match the filters, across every page.

Changes

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