Songlist API

Version: 2.0.0

Export

Download

Download JSON Download YAML

Copy URL

post/commands

Create command

Authorization

Required scopes

streamer.command.writeWrite streamer commands

Request Bodyrequired

application/json

Schema

CreateCommandParamsBody

$schemastring

A URL to the JSON Schema for this object.

actionstringrequired

aliasesstringrequired

altResponsesBotCommandAltResponses

accountNotConnectedstring

alreadyInQueuestring

atRequestLimitstring

cannotBumpstring

incorrectFormatstring

liveLearnDisabledstring

noInputstring

noQueuedSongsstring

noRequestToReplacestring

noSongPlayingstring

notEligiblestring

notEnoughTokensstring

playedTooRecentlystring

positionNotFoundstring

queueFullstring

queueNotClosedstring

requestNotFoundstring

requestsDisabledstring

songNotFoundstring

songRestrictedstring

songUnavailablestring

songsNotFoundstring

songsToLearnDisabledstring

tipTooLowstring

tokenAmountNotExactstring

tokenAmountTooLowstring

tokensDisabledstring

unknownErrorstring

userBlockedstring

userNotFoundstring

cooldownintegerrequired

enabledbooleanrequired

modOnlybooleanrequired

namestring

optionsBotCommandOptions

adminQueueAddAdminQueueAddOptions

onlyNewboolean

adminQueueAddLiveLearnAdminQueueAddLiveLearnOptions

onlyNewboolean

migratedFromstring

queueInsertQueueInsertOptions

overridePositioninteger

songRequestRandomSongRequestRandomOptions

includeRecentlyPlayedboolean

songSearchSongSearchOptions

byAttributeboolean

onlyActiveboolean

onlyInactiveboolean

responsestringrequired

streamerIdintegerrequired

Example

{
  "$schema": "https://example.com",
  "action": "string",
  "aliases": "string",
  "altResponses": {
    "accountNotConnected": "string",
    "alreadyInQueue": "string",
    "atRequestLimit": "string",
    "cannotBump": "string",
    "incorrectFormat": "string",
    "liveLearnDisabled": "string",
    "noInput": "string",
    "noQueuedSongs": "string",
    "noRequestToReplace": "string",
    "noSongPlaying": "string",
    "notEligible": "string",
    "notEnoughTokens": "string",
    "playedTooRecently": "string",
    "positionNotFound": "string",
    "queueFull": "string",
    "queueNotClosed": "string",
    "requestNotFound": "string",
    "requestsDisabled": "string",
    "songNotFound": "string",
    "songRestricted": "string",
    "songUnavailable": "string",
    "songsNotFound": "string",
    "songsToLearnDisabled": "string",
    "tipTooLow": "string",
    "tokenAmountNotExact": "string",
    "tokenAmountTooLow": "string",
    "tokensDisabled": "string",
    "unknownError": "string",
    "userBlocked": "string",
    "userNotFound": "string"
  },
  "cooldown": 0,
  "enabled": true,
  "modOnly": true,
  "name": "string",
  "options": {
    "adminQueueAdd": {
      "onlyNew": true
    },
    "adminQueueAddLiveLearn": {
      "onlyNew": true
    },
    "migratedFrom": "string",
    "queueInsert": {
      "overridePosition": 0
    },
    "songRequestRandom": {
      "includeRecentlyPlayed": true
    },
    "songSearch": {
      "byAttribute": true,
      "onlyActive": true,
      "onlyInactive": true
    }
  },
  "response": "string",
  "streamerId": 0
}

Responses

200OK

application/json

Schema

BotCommand

$schemastring

A URL to the JSON Schema for this object.

actionstringrequired

adminOnlybooleanrequired

aliasesstringrequired

altResponsesBotCommandAltResponsesrequired

accountNotConnectedstring

alreadyInQueuestring

atRequestLimitstring

cannotBumpstring

incorrectFormatstring

liveLearnDisabledstring

noInputstring

noQueuedSongsstring

noRequestToReplacestring

noSongPlayingstring

notEligiblestring

notEnoughTokensstring

playedTooRecentlystring

positionNotFoundstring

queueFullstring

queueNotClosedstring

requestNotFoundstring

requestsDisabledstring

songNotFoundstring

songRestrictedstring

songUnavailablestring

songsNotFoundstring

songsToLearnDisabledstring

tipTooLowstring

tokenAmountNotExactstring

tokenAmountTooLowstring

tokensDisabledstring

unknownErrorstring

userBlockedstring

userNotFoundstring

cooldownintegerrequired

defaultRefstringrequired

enabledbooleanrequired

idstringrequired

namestringrequired

optionsBotCommandOptionsrequired

adminQueueAddAdminQueueAddOptions

onlyNewboolean

adminQueueAddLiveLearnAdminQueueAddLiveLearnOptions

onlyNewboolean

migratedFromstring

queueInsertQueueInsertOptions

overridePositioninteger

songRequestRandomSongRequestRandomOptions

includeRecentlyPlayedboolean

songSearchSongSearchOptions

byAttributeboolean

onlyActiveboolean

onlyInactiveboolean

responsestringrequired

streamerIdintegerrequired

Example

{
  "$schema": "https://example.com",
  "action": "string",
  "adminOnly": true,
  "aliases": "string",
  "altResponses": {
    "accountNotConnected": "string",
    "alreadyInQueue": "string",
    "atRequestLimit": "string",
    "cannotBump": "string",
    "incorrectFormat": "string",
    "liveLearnDisabled": "string",
    "noInput": "string",
    "noQueuedSongs": "string",
    "noRequestToReplace": "string",
    "noSongPlaying": "string",
    "notEligible": "string",
    "notEnoughTokens": "string",
    "playedTooRecently": "string",
    "positionNotFound": "string",
    "queueFull": "string",
    "queueNotClosed": "string",
    "requestNotFound": "string",
    "requestsDisabled": "string",
    "songNotFound": "string",
    "songRestricted": "string",
    "songUnavailable": "string",
    "songsNotFound": "string",
    "songsToLearnDisabled": "string",
    "tipTooLow": "string",
    "tokenAmountNotExact": "string",
    "tokenAmountTooLow": "string",
    "tokensDisabled": "string",
    "unknownError": "string",
    "userBlocked": "string",
    "userNotFound": "string"
  },
  "cooldown": 0,
  "defaultRef": "string",
  "enabled": true,
  "id": "string",
  "name": "string",
  "options": {
    "adminQueueAdd": {
      "onlyNew": true
    },
    "adminQueueAddLiveLearn": {
      "onlyNew": true
    },
    "migratedFrom": "string",
    "queueInsert": {
      "overridePosition": 0
    },
    "songRequestRandom": {
      "includeRecentlyPlayed": true
    },
    "songSearch": {
      "byAttribute": true,
      "onlyActive": true,
      "onlyInactive": true
    }
  },
  "response": "string",
  "streamerId": 0
}

400Bad Request

application/problem+json

Schema

ErrorModel

$schemastring

A URL to the JSON Schema for this object.

detailstring

A human-readable explanation specific to this occurrence of the problem.

errorsErrorDetail[]

Optional list of individual error details

Array items:

ErrorDetail

locationstring

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

messagestring

Error message text

valueunknown

The value at the given location

instancestring

A URI reference that identifies the specific occurrence of the problem.

statusinteger

HTTP status code

titlestring

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

typestring

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

$schemastring

A URL to the JSON Schema for this object.

detailstring

A human-readable explanation specific to this occurrence of the problem.

errorsErrorDetail[]

Optional list of individual error details

Array items:

ErrorDetail

locationstring

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

messagestring

Error message text

valueunknown

The value at the given location

instancestring

A URI reference that identifies the specific occurrence of the problem.

statusinteger

HTTP status code

titlestring

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

typestring

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

$schemastring

A URL to the JSON Schema for this object.

detailstring

A human-readable explanation specific to this occurrence of the problem.

errorsErrorDetail[]

Optional list of individual error details

Array items:

ErrorDetail

locationstring

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

messagestring

Error message text

valueunknown

The value at the given location

instancestring

A URI reference that identifies the specific occurrence of the problem.

statusinteger

HTTP status code

titlestring

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

typestring

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

$schemastring

A URL to the JSON Schema for this object.

detailstring

A human-readable explanation specific to this occurrence of the problem.

errorsErrorDetail[]

Optional list of individual error details

Array items:

ErrorDetail

locationstring

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

messagestring

Error message text

valueunknown

The value at the given location

instancestring

A URI reference that identifies the specific occurrence of the problem.

statusinteger

HTTP status code

titlestring

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

typestring

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

$schemastring

A URL to the JSON Schema for this object.

detailstring

A human-readable explanation specific to this occurrence of the problem.

errorsErrorDetail[]

Optional list of individual error details

Array items:

ErrorDetail

locationstring

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

messagestring

Error message text

valueunknown

The value at the given location

instancestring

A URI reference that identifies the specific occurrence of the problem.

statusinteger

HTTP status code

titlestring

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

typestring

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"
}