Skip to main content

Create Playlist

POST 
/playlists

Creates a new playlist or album

Request​

Query Parameters

    user_id stringrequired

    The user ID of the user making the request

Body

required

    playlist_id string

    Optional playlist ID (will be generated if not provided)

    playlist_name stringrequired

    Possible values: non-empty

    Playlist or album name

    description string

    Possible values: <= 1000 characters

    Playlist description

    is_private boolean

    Whether the playlist is private

    is_album boolean

    Whether this is an album

    genre genre (string)

    Possible values: [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]

    Music genre

    mood mood (string)

    Possible values: [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

    tags string

    Comma-separated tags

    license string

    License type

    upc string

    Universal Product Code (for albums)

    release_date date

    Release date

    cover_art_cid string

    IPFS CID for cover art

    playlist_contents

    object[]

    Array of tracks in the playlist

  • Array [

    • metadata_timestamp integer

    Optional. Metadata timestamp for when the track was added to the playlist.

    timestamp integerrequired
    track_id stringrequired

  • ]

    • is_stream_gated booleannullable

    Whether streaming is restricted behind an access gate

    is_scheduled_release booleannullable

    Whether the playlist/album is a scheduled release

    stream_conditions

    object

    nullable

    oneOf

    tip_user_id integerrequired

    Must tip the given user ID to unlock

    ddex_app string

    DDEX application identifier

    ddex_release_ids

    object

    nullable

    DDEX release identifiers

    property name* string

    artists

    object[]

    nullable

    DDEX resource contributors / artists

  • Array [

    • name stringrequired

    Possible values: non-empty

    Contributor name

    roles string[]required

    Possible values: >= 1

    Contributor roles

    sequence_number integer

    Sequence number for ordering

  • ]

    • copyright_line

    object

    nullable

    year stringrequired

    Possible values: >= 4 characters and <= 4 characters

    Copyright year (4 characters)

    text stringrequired

    Possible values: non-empty

    Copyright text

    producer_copyright_line

    object

    nullable

    year stringrequired

    Possible values: >= 4 characters and <= 4 characters

    Copyright year (4 characters)

    text stringrequired

    Possible values: non-empty

    Copyright text

    parental_warning_type stringnullable

    Parental warning type

    is_image_autogenerated booleannullable

    Whether the image is autogenerated

Responses​

Playlist created successfully

Schema

    success boolean

    Whether the playlist was created successfully

    transaction_hash string

    The blockchain transaction hash

    playlist_id string

    The ID of the created playlist

Loading...