---
title: "List the read's soundscape beds and custom regions."
method: GET
path: "/artifacts/{artifactId}/soundscapes"
tags: ["Artifacts"]
---

# List the read's soundscape beds and custom regions.

`GET /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

Returns every scene's soundscape bed (over the lines it spans, `kind: "scene_bed"`, id = the scene index) and every custom region (`kind: "region"`), in script order, with each one's sound, level, fades and play mode. Read-only. Scope: `artifact:read`.

## Response `200`

The soundscapes.

- TableReadSoundscapesResponse
  - `artifactId` string, required
  - `soundscapes` TableReadSoundscape[], required
    - `kind` 'scene_bed' | 'region', required
    - `id` string, required: The scene index for a bed, the region id for a region.
    - `sceneIndex` integer, nullable, required
    - `label` string, required
    - `startEntry` integer, required
    - `endEntry` integer, required
    - `soundUrl` string, nullable, required
    - `libraryAssetId` string, nullable, required
    - `volume` number, nullable, required
    - `fadeInMs` number, nullable, required
    - `fadeOutMs` number, nullable, required
    - `playMode` 'loop' | 'stretch', nullable, required
    - `isDraft` boolean, required: A region not yet given a sound.

## Other responses

- `401`: Missing, malformed, revoked, or expired API key.
- `403`: API key is valid but lacks the scope, is blocked by IP allowlist, or the account is disabled.
- `404`: The story artifact does not exist or is owned by another account.
- `409`: The artifact is not in a state where this operation is valid yet (e.g. requesting an MP4 render before the share link exists).
- `429`: Rate limit for this API key + IP + route family was exceeded.
- `500`: The API failed unexpectedly. Safe to retry with the same Idempotency-Key.

---

[API](https://skmtc.dev/sleeperhit/apis/sleeper-hit-studio-story-api.md) · [All operations](https://skmtc.dev/sleeperhit/apis/sleeper-hit-studio-story-api/llms.txt) · [OpenAPI document](https://skmtc.dev/sleeperhit/apis/sleeper-hit-studio-story-api/revisions/64c1102ccb2f?raw)