Private playlists are user-generated collections of songs or sound effects. They are the same playlists available in the Soundstripe web app under My Media.
Use include=songs or include=sound_effects to return the playlist's media resources in the top-level included array. Included songs use the shared song object, including its isrc attribute.
Attributes
| Attribute | Type | Description |
|---|---|---|
| name | string | A name indicating the encapsulated playlist contents |
| description | string or null | A description of the playlist contents |
| duration | number | The combined length of all songs in the playlist in seconds |
| image | string | Playlist image URL. The w and h query string parameters (both 450px by default) can be updated to change the width and height of the image, respectively. Removing these parameters will return the full-resolution image. |
| song_ids | array<integer> | IDs of the songs in the playlist. Empty for a sound-effect playlist. |
| sound_effect_ids | array<integer> | IDs of the sound effects in the playlist. Empty for a song playlist. |
| media_type | string | The type of media the playlist contains (songs or sound_effects) |
| shareable | boolean | Whether the playlist is publicly published. |
Example
{
"data": {
"id": "272249",
"type": "private_playlists",
"attributes": {
"name": "My First Playlist",
"description": "A collection of my favorite Soundstripe songs",
"duration": 6948.34267,
"image": "https://soundstripe-production.imgix.net/uploads/playlist/489681/pic/5cec28842f.jpeg?auto=format",
"song_ids": [
7055,
7571,
7154,
7368,
7733,
5512,
7103,
7589,
7278,
7302,
6980,
7455,
7444,
7065,
7140,
6996,
7515,
7930,
8836,
8835,
8834,
8832,
8831,
8778,
9183,
9801,
9802,
9809,
9891,
9892,
9893,
9995,
10462,
10464,
10527,
10533,
10702,
12367,
12578
],
"sound_effect_ids": [],
"media_type": "songs",
"shareable": false
},
"relationships": {
"songs": {
"data": [
{
"id": "7055",
"type": "songs"
},
{
"id": "7571",
"type": "songs"
},
{
"id": "7154",
"type": "songs"
},
{
"id": "7368",
"type": "songs"
},
{
"id": "7733",
"type": "songs"
},
{
"id": "5512",
"type": "songs"
},
{
"id": "7103",
"type": "songs"
},
{
"id": "7589",
"type": "songs"
},
{
"id": "7278",
"type": "songs"
},
{
"id": "7302",
"type": "songs"
},
{
"id": "6980",
"type": "songs"
},
{
"id": "7455",
"type": "songs"
},
{
"id": "7444",
"type": "songs"
},
{
"id": "7065",
"type": "songs"
},
{
"id": "7140",
"type": "songs"
},
{
"id": "6996",
"type": "songs"
},
{
"id": "7515",
"type": "songs"
},
{
"id": "7930",
"type": "songs"
},
{
"id": "8836",
"type": "songs"
},
{
"id": "8835",
"type": "songs"
},
{
"id": "8834",
"type": "songs"
},
{
"id": "8832",
"type": "songs"
},
{
"id": "8831",
"type": "songs"
},
{
"id": "8778",
"type": "songs"
},
{
"id": "9183",
"type": "songs"
},
{
"id": "9801",
"type": "songs"
},
{
"id": "9802",
"type": "songs"
},
{
"id": "9809",
"type": "songs"
},
{
"id": "9891",
"type": "songs"
},
{
"id": "9892",
"type": "songs"
},
{
"id": "9893",
"type": "songs"
},
{
"id": "9995",
"type": "songs"
},
{
"id": "10462",
"type": "songs"
},
{
"id": "10464",
"type": "songs"
},
{
"id": "10527",
"type": "songs"
},
{
"id": "10533",
"type": "songs"
},
{
"id": "10702",
"type": "songs"
},
{
"id": "12367",
"type": "songs"
},
{
"id": "12578",
"type": "songs"
}
]
}
}
}
}