List Audio Backgrounds

List the audio background catalog

Info

Required scope: studio.read

Warning

This method requires authentication

Retrieve the catalog of audio background channels available to the authenticated user in Studio. The catalog is organized as categories → groups → channels, mirroring how it is presented in the Studio UI.

A channel is the smallest addressable unit — pass its id to the Studio playback APIs to start streaming. emoji and icon are decorative hints for rendering the channel; either may be null.

curl -H "Authorization: Bearer [access token]" \
     https://api.restream.io/v2/user/studio/audio-backgrounds

Response

Success
Error
{
  "backgrounds": [
    {
      "id": 1,
      "name": "Focus",
      "groups": [
        {
          "id": 11,
          "name": "Lo-fi",
          "channels": [
            {
              "id": 101,
              "name": "Lo-fi Beats",
              "emoji": "🎧",
              "icon": "https://studio-assets.restream.io/audio-backgrounds/lofi-beats.png"
            },
            {
              "id": 102,
              "name": "Late Night Study",
              "emoji": null,
              "icon": "https://studio-assets.restream.io/audio-backgrounds/late-night.png"
            }
          ]
        }
      ]
    },
    {
      "id": 2,
      "name": "Energy",
      "groups": [
        {
          "id": 21,
          "name": "Workout",
          "channels": [
            {
              "id": 201,
              "name": "Power Hour",
              "emoji": "💪",
              "icon": null
            }
          ]
        }
      ]
    }
  ]
}