Songlist API
Version: 2.0.0
Export
/queueCreate queue
Authorization
Required scopes
streamer.queue.writeWrite streamer queue
Request Bodyrequired
application/json
Schema
CreateQueueParamsBody
A URL to the JSON Schema for this object.
How the song is inserted into the queue. Defaults to the streamer's queue ordering.
Artist of a non-list (Live Learn) song. Requires nonlistTitle.
A non-list (Live Learn) song as one string. Send this or nonlistTitle, not both.
Title of a non-list (Live Learn) song.
Where to insert the song: "playing" (or 0) claims the now-playing slot and moves the current song to the head of the queue, or a 1-based upcoming queue position. Overrides insertMethod.
Which band the entry sits in. Every entry in a higher band outranks every entry in a lower one, whatever either paid. Defaults to "normal".
Search string to resolve to a song from the streamer's songlist. Use instead of songId when the caller doesn't know the ID.
Array items:
Item
This along with "name" is used to find the user's ID. If 'custom' is supplied, the user is ignored
The streamer's ID. Can be found using the GET /streamers endpoint with the streamer_name and platform parameters
Example
{
"$schema": "https://example.com",
"insertMethod": "position",
"nonlistArtist": "string",
"nonlistSong": "string",
"nonlistTitle": "string",
"note": "string",
"position": "string",
"priority": "low",
"query": "string",
"requests": [
{
"amount": 0,
"name": "string",
"note": "string",
"userId": 0,
"userType": "custom"
}
],
"songId": 0,
"streamerId": 1
}Responses
201Created
application/json
Schema
QueueResponseBody
A URL to the JSON Schema for this object.
Array items:
QueueDetails
A URL to the JSON Schema for this object.
Array items:
Request
Array items:
QueueSongAttribute
Array items:
Request
Array items:
QueueSongAttribute
Example
{
"$schema": "https://example.com",
"items": [
{
"$schema": "https://example.com",
"createdAt": "2024-01-01T00:00:00Z",
"id": 0,
"nonlistArtist": "string",
"nonlistSong": "string",
"nonlistTitle": "string",
"note": "string",
"position": 0,
"priority": "string",
"requests": [
{
"amount": 0,
"createdAt": "string",
"id": 0,
"mine": true,
"name": "string",
"requestText": "string",
"source": "string",
"user": {
"platform": "string",
"username": "string"
}
}
],
"song": {
"albumArt": "string",
"artist": "string",
"attributes": [
{
"image": "string",
"name": "string"
}
],
"capo": "string",
"comment": "string",
"duration": 0,
"hasChords": true,
"hasLyrics": true,
"hasTabs": true,
"isNew": true,
"lastPlayed": "2024-01-01T00:00:00Z",
"lastPlayedFrom": "string",
"timesPlayed": 0,
"title": "string"
},
"songId": 0,
"streamerId": 0
}
],
"playing": {
"createdAt": "2024-01-01T00:00:00Z",
"id": 0,
"nonlistArtist": "string",
"nonlistSong": "string",
"nonlistTitle": "string",
"note": "string",
"nowPlayingStartedAt": "2024-01-01T00:00:00Z",
"priority": "string",
"requests": [
{
"amount": 0,
"createdAt": "string",
"id": 0,
"mine": true,
"name": "string",
"requestText": "string",
"source": "string",
"user": {
"platform": "string",
"username": "string"
}
}
],
"song": {
"albumArt": "string",
"artist": "string",
"attributes": [
{
"image": "string",
"name": "string"
}
],
"capo": "string",
"comment": "string",
"duration": 0,
"hasChords": true,
"hasLyrics": true,
"hasTabs": true,
"isNew": true,
"lastPlayed": "2024-01-01T00:00:00Z",
"lastPlayedFrom": "string",
"timesPlayed": 0,
"title": "string"
},
"songId": 0,
"streamerId": 0
},
"total": 0
}400Bad Request
application/problem+json
Schema
ErrorModel
A URL to the JSON Schema for this object.
A human-readable explanation specific to this occurrence of the problem.
Optional list of individual error details
Array items:
ErrorDetail
Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
Error message text
The value at the given location
A URI reference that identifies the specific occurrence of the problem.
HTTP status code
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
A URI reference to human-readable documentation for the error.
Example
{
"$schema": "https://example.com",
"detail": "string",
"errors": [
{
"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com",
"status": 0,
"title": "string",
"type": "about:blank"
}401Unauthorized
application/problem+json
Schema
ErrorModel
A URL to the JSON Schema for this object.
A human-readable explanation specific to this occurrence of the problem.
Optional list of individual error details
Array items:
ErrorDetail
Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
Error message text
The value at the given location
A URI reference that identifies the specific occurrence of the problem.
HTTP status code
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
A URI reference to human-readable documentation for the error.
Example
{
"$schema": "https://example.com",
"detail": "string",
"errors": [
{
"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com",
"status": 0,
"title": "string",
"type": "about:blank"
}403Forbidden
application/problem+json
Schema
ErrorModel
A URL to the JSON Schema for this object.
A human-readable explanation specific to this occurrence of the problem.
Optional list of individual error details
Array items:
ErrorDetail
Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
Error message text
The value at the given location
A URI reference that identifies the specific occurrence of the problem.
HTTP status code
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
A URI reference to human-readable documentation for the error.
Example
{
"$schema": "https://example.com",
"detail": "string",
"errors": [
{
"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com",
"status": 0,
"title": "string",
"type": "about:blank"
}422Unprocessable Entity
application/problem+json
Schema
ErrorModel
A URL to the JSON Schema for this object.
A human-readable explanation specific to this occurrence of the problem.
Optional list of individual error details
Array items:
ErrorDetail
Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
Error message text
The value at the given location
A URI reference that identifies the specific occurrence of the problem.
HTTP status code
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
A URI reference to human-readable documentation for the error.
Example
{
"$schema": "https://example.com",
"detail": "string",
"errors": [
{
"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com",
"status": 0,
"title": "string",
"type": "about:blank"
}500Internal Server Error
application/problem+json
Schema
ErrorModel
A URL to the JSON Schema for this object.
A human-readable explanation specific to this occurrence of the problem.
Optional list of individual error details
Array items:
ErrorDetail
Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
Error message text
The value at the given location
A URI reference that identifies the specific occurrence of the problem.
HTTP status code
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
A URI reference to human-readable documentation for the error.
Example
{
"$schema": "https://example.com",
"detail": "string",
"errors": [
{
"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com",
"status": 0,
"title": "string",
"type": "about:blank"
}