Skip to content

PostSong

Walter Lara edited this page Dec 3, 2022 · 20 revisions

Post Song

Allows to add a new Song.

Request

URL: /v1/songs

Method: POST

Path Parameters: None

Query Parameters: None

Headers:

Authorization: Bearer {accessToken}

Content-Type: application/json

Content:

Field Type Description Requirement Type
title string Song title. Required
genre string Song genre. Required
coverArtUrl string Valid URL of cover art picture file. Optional
description string Song description. Optional
credits string Song production credits. Optional
duration integer Song duration in milliseconds. This field is automatically updated after the song audio file is uploaded. Optional
streamUrl string Song streaming URL. This field is automatically updated after the song audio file is uploaded. Optional
nftPolicyId string Song NFT Policy ID. Optional
nftName string Song NFT Name. Optional
mintingStatus string Song minting status (valid values: NotEarning, Earning, Pending, Rejected) Optional
marketplaceStatus string Song marketplace status (valid values: NotSelling, Selling) Optional

Content example:

{
    "title": "Blinding Lights",
    "genre": "Synthwave",
    "coverArtUrl": "https://somewebsite/weeknd-cover.png",
    "description": "Song by The Weeknd",
    "credits": "Produced by Max Martin and Oscar Holter",
    "streamUrl": "https://www.example.com/blinding_lights.m4a",
    "nftPolicyId": "11123344555",
    "nftPolicyName": "Blinding Lights NFT",
    "mintingStatus": "Earning",
    "marketplaceStatus": "Selling"
}

✅ Success Response

Code: 200 OK

Headers:

Content-Type: application/json

Content:

Field Type Description Condition
songId string UUID of the added Song. Always

Content example:

{
    "songId": "7bd2862f-8deb-4814-8943-156d9dab80dd"
}

❌ Error Responses

1. Bad Request

Code: 400 BAD REQUEST

Condition: If a mandatory content field is missing.

Headers:

Content-Type: application/json

Content example:

{
    "code": 400,
    "description": "Bad Request",
    "cause": "missing title"
}

2. Unauthorized

Code: 401 UNAUTHORIZED

Condition: If {accessToken} is invalid or expired.

See Also

Patch Song (Update Song)

Get Song

Get Songs

Delete Song

Upload Song Audio

Get Song Genres

Clone this wiki locally