latestOpenAPI 3.0.02026-08-203145159.1 KB

0e40a805593b

audio experiences

List soundscapes

Returns a paginated list of soundscapes — ambient audio tracks such as rainfall, ocean waves, and forest sounds that support focus, relaxation, and sleep. Each soundscape includes its playable audio, duration, imagery, captions where available, and tags.

get/v1/soundscapes

Query parameters

offsetinteger

Zero-based item offset

limitinteger

Page size. Values above 100 are clamped to 100, not rejected; meta.pagination reports the applied value.

localestring

Locale, forwarded as the thrive-locale header

Response

A page of soundscapes

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"
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "limit": 10
    }
  },
  "links": {
    "self": "/v1/soundscapes?offset=0&limit=10",
    "next": "/v1/soundscapes?offset=10&limit=10"
  }
}