Music

Generated music operations.

GET/v1/music/mixesRead the current profile's permitted listening mixesread

Audience: Clients · Native API
Authorization: API key or personal access token with the read scope, or a signed-in session
OpenAPI operation ID: get_music_mixes

Responses

200Successapplication/json

Example

{
  "data": {
    "mixes": [
      {
        "artists": [
          {}
        ],
        "covers": [
          {}
        ],
        "id": "id_8h2k4q",
        "more": true,
        "nameSource": {
          "kind": "style",
          "model": "string",
          "tag": "string",
          "version": "string"
        },
        "songCount": 1,
        "tint": "string"
      }
    ]
  },
  "scope": {
    "accountId": "id_8h2k4q",
    "authority": "string",
    "profileId": "id_8h2k4q",
    "serverId": "id_8h2k4q"
  }
}

Schema

dataobjectrequired
- mixesarray of objectrequired
  - artistsarray of objectrequired0–2 items
    idstringrequired
    namestringrequired
  - coversarray of objectrequired3–3 items
    albumobjectrequired
    idstringrequired
    namestringrequired
    posterUrlstringrequired
  - idstringrequiredlength 1–∞
  - morebooleanrequired
  - nameSourceobjectrequired
    kind"style"required
    modelstringrequiredlength 1–∞
    tagstringrequiredlength 1–∞
    versionstringrequiredlength 1–∞
  - songCountintegerrequired1–200
  - tintstringrequiredpattern ^#[0-9a-fA-F]{6}$
scopeobjectrequired
- accountIdstringrequired
- authoritystringrequired
- profileIdstringrequired
- serverIdstringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundstale_continuationinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/music/mixes" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

POST/v1/music/mixes/{id}/playlistCopy a permitted mix into an ordinary playlistplayback

Audience: Clients · Native API
Authorization: API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID: post_music_mixes_id_playlist
Max body: 4 KiB

Parameters

Name	In	Type	Description
`id`required	path	`string`

Request body application/json · required

Example

{
  "name": "Fargo",
  "operationId": "id_8h2k4q"
}

Schema

namestringrequiredlength 1–200
operationIdstringrequiredlength 1–∞

Responses

200Successapplication/json

Example

{
  "deleted": true,
  "entryId": "id_8h2k4q",
  "operationId": "id_8h2k4q",
  "playlistId": "id_8h2k4q",
  "revision": 0,
  "serverId": "id_8h2k4q",
  "undoToken": "string",
  "undoUntil": "string",
  "viewerFence": "string"
}

Schema

deletedbooleanrequired
entryIdstring
operationIdstringrequired
playlistIdstringrequired
revisionintegerrequired
serverIdstringrequired
undoTokenstring
undoUntilstring
viewerFencestringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundplaylist_capacityidempotency_key_reusedinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/music/mixes/{id}/playlist" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Fargo","operationId":"id_8h2k4q"}'