Get background music library

Request

Retrieve all available background music tracks.

Use the relativePath value as customTemplate.preConfigs.bgMusic.path when creating a project to set the background music.

Security

ShuffllApiKey

curl -i -X GET \
  https://api-docs.shuffll.com/_mock/apis/auth/config/music-library \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successfully retrieved music library.

Bodyapplication/json

Array [

idstring

Track identifier

Example:"track_upbeat_001"

namestring

Track name

Example:"Upbeat Corporate"

relativePathstring

Path to use as customTemplate.preConfigs.bgMusic.path when creating a project

Example:"/music/upbeat-corporate.mp3"

imagestring

Track artwork URL

Example:"https://content.shuffll.com/music/upbeat-corporate-cover.jpg"

]

Response

[
  {
    "id": "track_upbeat_001",
    "name": "Upbeat Corporate",
    "relativePath": "/music/upbeat-corporate.mp3",
    "image": "https://content.shuffll.com/music/upbeat-corporate-cover.jpg"
  },
  {
    "id": "track_ambient_002",
    "name": "Ambient Focus",
    "relativePath": "/music/ambient-focus.mp3",
    "image": "https://content.shuffll.com/music/ambient-focus-cover.jpg"
  },
  {
    "id": "track_cinematic_003",
    "name": "Cinematic Inspire",
    "relativePath": "/music/cinematic-inspire.mp3",
    "image": "https://content.shuffll.com/music/cinematic-inspire-cover.jpg"
  }
]