Sign in
audio experiences

Get a soundscape by id

Returns a single soundscape by its id, including its playable audio, duration, imagery, captions where available, and tags. Returns 404 when no soundscape exists for the id and 422 when the id is not a UUID.

get/v1/soundscapes/{id}

Path parameters

idstring uuid required

Soundscape id

Query parameters

localestring

Locale, forwarded as the thrive-locale header

Response

The soundscape

Example response

{
  "data": {
    "name": "Forest Rain",
    "tags": [
      {
        "slug": "sleep",
        "name": "Sleep"
      }
    ],
    "conditions": [
      {
        "slug": "sleep",
        "name": "Sleep"
      }
    ],
    "coreHealthBehaviors": [
      {
        "slug": "sleep",
        "name": "Sleep"
      }
    ],
    "durationInSeconds": 600,
    "media": [
      {
        "contentType": "audio/mpeg"
      }
    ],
    "assets": [
      {
        "contentType": "image/jpeg"
      }
    ]
  }
}

Changes

No recorded changes to this endpoint across all 4 revisions of this API.