Sign in
playlists

Creates a new playlist or album

post/playlists

Query parameters

user_idstring required

The user ID of the user making the request

Request body

playlist_idstring

Optional playlist ID (will be generated if not provided)

playlist_namestring required

Playlist or album name

descriptionstring

Playlist description

is_privateboolean

Whether the playlist is private

is_albumboolean

Whether this is an album

genrestring

Music genre. Any string up to 100 characters is accepted. Known/canonical values (shown as autocomplete suggestions in clients): Electronic, Rock, Metal, Alternative, Hip-Hop/Rap, Experimental, Punk, Folk, Pop, Ambient, Soundtrack, World, Jazz, Acoustic, Funk, R&B/Soul, Devotional, Classical, Reggae, Podcasts, Country, Spoken Word, Comedy, Blues, Kids, Audiobooks, Latin, Lo-Fi, Hyperpop, Dancehall, Techno, Trap, House, Tech House, Deep House, Disco, Electro, Jungle, Progressive House, Hardstyle, Glitch Hop, Trance, Future Bass, Future House, Tropical House, Downtempo, Drum & Bass, Dubstep, Jersey Club, Vaporwave, Moombahton.

mood'Peaceful' | 'Romantic' | 'Sentimental' | 'Tender' | 'Easygoing' | 'Yearning' | 'Sophisticated' | 'Sensual' | 'Cool' | 'Gritty' | 'Melancholy' | 'Serious' | 'Brooding' | 'Fiery' | 'Defiant' | 'Aggressive' | 'Rowdy' | 'Excited' | 'Energizing' | 'Empowering' | 'Stirring' | 'Upbeat' | 'Other'

Music mood

tagsstring

Comma-separated tags

licensestring

License type

upcstring

Universal Product Code (for albums)

release_datestring date

Release date

playlist_image_sizes_multihashstring

CID for the playlist cover art

is_stream_gatedboolean nullable

Whether streaming is restricted behind an access gate

is_scheduled_releaseboolean nullable

Whether the playlist/album is a scheduled release

ddex_appstring

DDEX application identifier

ddex_release_idsobject nullable

DDEX release identifiers

parental_warning_typestring nullable

Parental warning type

is_image_autogeneratedboolean nullable

Whether the image is autogenerated

Example request

{
  "playlist_id": "x5pJ3Az",
  "playlist_name": "My New Playlist",
  "stream_conditions": {
    "usdc_purchase": {
      "splits": [
        {
          "user_id": 1234
        }
      ]
    }
  }
}

Response

Playlist created successfully

transaction_hashstring

The blockchain transaction hash

block_hashstring

The blockchain block hash

block_numberinteger

The blockchain block number/height

playlist_idstring

The ID of the created playlist

Changes

No recorded changes to this endpoint across all 1 revision of this API.