Melody Catalog Service API

Artist Pick

Endpointhttps://melody-gateway-main-0d30d7f.d2.zuplo.dev

Endpoints for managing artist pick

Set or update artist pick

PUT

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/artists/me/pick

Creates or updates the artist pick. Returns the resolved resource (collection or playlist summary)

Set or update artist pick › Request Body

Request to set or update artist pick

type

string · enum · required

Type of the picked resource (COLLECTION or PLAYLIST)

Enum values:

PLAYLIST

COLLECTION

resourceId

string · uuid · required

ID of the picked resource

Set or update artist pick › Responses

200

Response containing artist pick with resolved resource

type

string · enum

Type of the picked resource (COLLECTION or PLAYLIST)

Enum values:

PLAYLIST

COLLECTION

resourceId

string · uuid

ID of the picked resource

object

Response object containing collection summary

object

timestamp

integer · int64

Timestamp when the pick was set

PUT/artists/me/pick

curl --request PUT \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/artists/me/pick \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "PLAYLIST",
  "resourceId": "00000000-0000-0000-0000-000000000000"
}
'

shell

Example Request Body

{
  "type": "PLAYLIST",
  "resourceId": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "type": "PLAYLIST",
  "resourceId": "00000000-0000-0000-0000-000000000000",
  "collection": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "title": "Summer Hits 2023",
    "description": "Best hits of summer 2023",
    "coverUrl": "https://example.com/cover.jpg",
    "type": "ALBUM",
    "effectiveState": "PUBLISHED",
    "primaryArtistId": "00000000-0000-0000-0000-000000000000",
    "primaryArtistName": "Queen",
    "scheduledReleaseDate": "2024-08-25T15:00:00Z",
    "actualReleaseDate": "2024-08-25T15:00:00Z",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "relevanceScore": 9500,
    "levenshteinDistance": 2,
    "isSaved": true
  },
  "playlist": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "title": "Chill Vibes",
    "coverUrl": "https://example.com/cover.jpg",
    "userId": "987e6543-e21b-12d3-a456-426614174000",
    "username": "music_lover42",
    "isPublic": true,
    "songCount": 25,
    "createdAt": "2023-08-15T10:00:00Z",
    "updatedAt": "2023-09-01T12:30:00Z",
    "relevanceScore": 9500,
    "levenshteinDistance": 2,
    "isSaved": true
  },
  "timestamp": 0
}

plain

*/*

Remove artist pick

DELETE

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/artists/me/pick

Removes the artist pick

Remove artist pick › Responses

200

No data returned

DELETE/artists/me/pick

curl --request DELETE \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/artists/me/pick

shell

Example Responses

No example specified for this content type

Get current artist pick

GET

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/artists/{id}/pick

Returns the artist pick with resolved collection or playlist summary

Get current artist pick › path Parameters

id

string · uuid · required

Get current artist pick › Responses

200

Response containing artist pick with resolved resource

type

string · enum

Type of the picked resource (COLLECTION or PLAYLIST)

Enum values:

PLAYLIST

COLLECTION

resourceId

string · uuid

ID of the picked resource

object

Response object containing collection summary

object

timestamp

integer · int64

Timestamp when the pick was set

GET/artists/{id}/pick

curl --request GET \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/artists/:id/pick

shell

Example Responses

{
  "type": "PLAYLIST",
  "resourceId": "00000000-0000-0000-0000-000000000000",
  "collection": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "title": "Summer Hits 2023",
    "description": "Best hits of summer 2023",
    "coverUrl": "https://example.com/cover.jpg",
    "type": "ALBUM",
    "effectiveState": "PUBLISHED",
    "primaryArtistId": "00000000-0000-0000-0000-000000000000",
    "primaryArtistName": "Queen",
    "scheduledReleaseDate": "2024-08-25T15:00:00Z",
    "actualReleaseDate": "2024-08-25T15:00:00Z",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "relevanceScore": 9500,
    "levenshteinDistance": 2,
    "isSaved": true
  },
  "playlist": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "title": "Chill Vibes",
    "coverUrl": "https://example.com/cover.jpg",
    "userId": "987e6543-e21b-12d3-a456-426614174000",
    "username": "music_lover42",
    "isPublic": true,
    "songCount": 25,
    "createdAt": "2023-08-15T10:00:00Z",
    "updatedAt": "2023-09-01T12:30:00Z",
    "relevanceScore": 9500,
    "levenshteinDistance": 2,
    "isSaved": true
  },
  "timestamp": 0
}

plain

*/*

Home Playback

Melody Catalog Service API

Artist Pick

Endpointhttps://melody-gateway-main-0d30d7f.d2.zuplo.dev

Endpoints for managing artist pick

Set or update artist pick

PUT

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/artists/me/pick

Creates or updates the artist pick. Returns the resolved resource (collection or playlist summary)

Set or update artist pick › Request Body

Request to set or update artist pick

type

string · enum · required

Type of the picked resource (COLLECTION or PLAYLIST)

Enum values:

PLAYLIST

COLLECTION

resourceId

string · uuid · required

ID of the picked resource

Set or update artist pick › Responses

200

Response containing artist pick with resolved resource

type

string · enum

Type of the picked resource (COLLECTION or PLAYLIST)

Enum values:

PLAYLIST

COLLECTION

resourceId

string · uuid

ID of the picked resource

object

Response object containing collection summary

object

timestamp

integer · int64

Timestamp when the pick was set

PUT/artists/me/pick

curl --request PUT \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/artists/me/pick \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "PLAYLIST",
  "resourceId": "00000000-0000-0000-0000-000000000000"
}
'

shell

Example Request Body

{
  "type": "PLAYLIST",
  "resourceId": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "type": "PLAYLIST",
  "resourceId": "00000000-0000-0000-0000-000000000000",
  "collection": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "title": "Summer Hits 2023",
    "description": "Best hits of summer 2023",
    "coverUrl": "https://example.com/cover.jpg",
    "type": "ALBUM",
    "effectiveState": "PUBLISHED",
    "primaryArtistId": "00000000-0000-0000-0000-000000000000",
    "primaryArtistName": "Queen",
    "scheduledReleaseDate": "2024-08-25T15:00:00Z",
    "actualReleaseDate": "2024-08-25T15:00:00Z",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "relevanceScore": 9500,
    "levenshteinDistance": 2,
    "isSaved": true
  },
  "playlist": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "title": "Chill Vibes",
    "coverUrl": "https://example.com/cover.jpg",
    "userId": "987e6543-e21b-12d3-a456-426614174000",
    "username": "music_lover42",
    "isPublic": true,
    "songCount": 25,
    "createdAt": "2023-08-15T10:00:00Z",
    "updatedAt": "2023-09-01T12:30:00Z",
    "relevanceScore": 9500,
    "levenshteinDistance": 2,
    "isSaved": true
  },
  "timestamp": 0
}

plain

*/*

Remove artist pick

DELETE

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/artists/me/pick

Removes the artist pick

Remove artist pick › Responses

200

No data returned

DELETE/artists/me/pick

curl --request DELETE \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/artists/me/pick

shell

Example Responses

No example specified for this content type

Get current artist pick

GET

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/artists/{id}/pick

Returns the artist pick with resolved collection or playlist summary

Get current artist pick › path Parameters

id

string · uuid · required

Get current artist pick › Responses

200

Response containing artist pick with resolved resource

type

string · enum

Type of the picked resource (COLLECTION or PLAYLIST)

Enum values:

PLAYLIST

COLLECTION

resourceId

string · uuid

ID of the picked resource

object

Response object containing collection summary

object

timestamp

integer · int64

Timestamp when the pick was set

GET/artists/{id}/pick

curl --request GET \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/artists/:id/pick

shell

Example Responses

{
  "type": "PLAYLIST",
  "resourceId": "00000000-0000-0000-0000-000000000000",
  "collection": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "title": "Summer Hits 2023",
    "description": "Best hits of summer 2023",
    "coverUrl": "https://example.com/cover.jpg",
    "type": "ALBUM",
    "effectiveState": "PUBLISHED",
    "primaryArtistId": "00000000-0000-0000-0000-000000000000",
    "primaryArtistName": "Queen",
    "scheduledReleaseDate": "2024-08-25T15:00:00Z",
    "actualReleaseDate": "2024-08-25T15:00:00Z",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "relevanceScore": 9500,
    "levenshteinDistance": 2,
    "isSaved": true
  },
  "playlist": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "title": "Chill Vibes",
    "coverUrl": "https://example.com/cover.jpg",
    "userId": "987e6543-e21b-12d3-a456-426614174000",
    "username": "music_lover42",
    "isPublic": true,
    "songCount": 25,
    "createdAt": "2023-08-15T10:00:00Z",
    "updatedAt": "2023-09-01T12:30:00Z",
    "relevanceScore": 9500,
    "levenshteinDistance": 2,
    "isSaved": true
  },
  "timestamp": 0
}

plain

*/*

Home Playback