Songlist API

Version: 2.0.0

Export

Download

Download JSON Download YAML

Copy URL

patch/streamers

Update streamer request and queue settings

Authorization

Required scopes

streamer.settings.writeWrite streamer settings

Parameters

Name	In	Type	Required	Description
streamer_id	query	string	No	If not provided, 'streamer_name' and 'platform' are required
streamer_name	query	string	No	Required if streamer_id is not supplied
platform_id	query	string	No	Platform-specific channel ID. Requires 'platform'
platform	query	string kicknonetwitchyoutube	No	Required if streamer_name or platform_id is supplied

Request Bodyrequired

application/json

Schema

PublicUpdateStreamerBody

$schemastring

A URL to the JSON Schema for this object.

adminBypassRestrictionsboolean

allowDuplicatesboolean

allowLiveLearnsboolean

canAnonymousEnterNameboolean

canAnonymousRequestboolean

canUserRequestboolean

concurrentRequestsinteger

concurrentRequestsPerAdmininteger

concurrentRequestsPerAnonymousinteger

concurrentRequestsPerUserinteger

donationsIgnoreLimitsboolean

enableCrossPlatformRequestsboolean

fixedTokenPriceboolean

integrationsIntegrationSettingsUpdate

kickKickIntegrationSettingsUpdate

botConnectedboolean

followerRequestTypeSettingsUpdate

concurrentinteger

enabledboolean

limitboolean

requestsinteger

subscriberRequestTypeSettingsUpdate

concurrentinteger

enabledboolean

limitboolean

requestsinteger

userRequestTypeSettingsUpdate

concurrentinteger

enabledboolean

limitboolean

requestsinteger

streamelementsStreamelementsSettingsUpdate

sendChatMessageboolean

streamlabsStreamlabsSettingsUpdate

sendChatMessageboolean

twitchTwitchStreamerSettingsUpdate

botConnectedboolean

followerRequestTypeSettingsUpdate

concurrentinteger

enabledboolean

limitboolean

requestsinteger

subscriberT1RequestTypeSettingsUpdate

concurrentinteger

enabledboolean

limitboolean

requestsinteger

subscriberT2RequestTypeSettingsUpdate

concurrentinteger

enabledboolean

limitboolean

requestsinteger

subscriberT3RequestTypeSettingsUpdate

concurrentinteger

enabledboolean

limitboolean

requestsinteger

userRequestTypeSettingsUpdate

concurrentinteger

enabledboolean

limitboolean

requestsinteger

vipRequestTypeSettingsUpdate

concurrentinteger

enabledboolean

limitboolean

requestsinteger

youtubeYoutubeStreamerSettingsUpdate

botConnectedboolean

memberRequestTypeSettingsUpdate

concurrentinteger

enabledboolean

limitboolean

requestsinteger

membershipLevelsobject

subscriberRequestTypeSettingsUpdate

concurrentinteger

enabledboolean

limitboolean

requestsinteger

userRequestTypeSettingsUpdate

concurrentinteger

enabledboolean

limitboolean

requestsinteger

limitAdminRequestsboolean

limitAnonymousRequestsboolean

liveLearnsNoSongFoundboolean

maxRequestsinteger

minAmountnumber

minLiveLearnAmountnumber

minTipAmountForQueueOrderingnumber

minTokensForBumpnumber

minTokensToIgnoreLimitsnumber

minutesBetweenRequestsinteger

newDaysinteger

permitConfigPermitConfig

bypassesstring[]required

Array items:

string

default_duration_secondsintegerrequired

no_expirybooleanrequired

promoteQueueToPlayingboolean

queueOrderModestring

amounttoken_presence

requestModestring

anyfollowersubdonation

requestsActiveboolean

requestsPerAdmininteger

requestsPerAnonymousinteger

requestsPerUserinteger

sessionLengthinteger

syncPlatformBansboolean

trackSongDurationboolean

Example

{
  "$schema": "https://example.com",
  "adminBypassRestrictions": true,
  "allowDuplicates": true,
  "allowLiveLearns": true,
  "canAnonymousEnterName": true,
  "canAnonymousRequest": true,
  "canUserRequest": true,
  "concurrentRequests": 0,
  "concurrentRequestsPerAdmin": 0,
  "concurrentRequestsPerAnonymous": 0,
  "concurrentRequestsPerUser": 0,
  "donationsIgnoreLimits": true,
  "enableCrossPlatformRequests": true,
  "fixedTokenPrice": true,
  "integrations": {
    "kick": {
      "botConnected": true,
      "follower": {
        "concurrent": 0,
        "enabled": true,
        "limit": true,
        "requests": 0
      },
      "subscriber": {
        "concurrent": 0,
        "enabled": true,
        "limit": true,
        "requests": 0
      },
      "user": {
        "concurrent": 0,
        "enabled": true,
        "limit": true,
        "requests": 0
      }
    },
    "streamelements": {
      "sendChatMessage": true
    },
    "streamlabs": {
      "sendChatMessage": true
    },
    "twitch": {
      "botConnected": true,
      "follower": {
        "concurrent": 0,
        "enabled": true,
        "limit": true,
        "requests": 0
      },
      "subscriberT1": {
        "concurrent": 0,
        "enabled": true,
        "limit": true,
        "requests": 0
      },
      "subscriberT2": {
        "concurrent": 0,
        "enabled": true,
        "limit": true,
        "requests": 0
      },
      "subscriberT3": {
        "concurrent": 0,
        "enabled": true,
        "limit": true,
        "requests": 0
      },
      "user": {
        "concurrent": 0,
        "enabled": true,
        "limit": true,
        "requests": 0
      },
      "vip": {
        "concurrent": 0,
        "enabled": true,
        "limit": true,
        "requests": 0
      }
    },
    "youtube": {
      "botConnected": true,
      "member": {
        "concurrent": 0,
        "enabled": true,
        "limit": true,
        "requests": 0
      },
      "membershipLevels": {},
      "subscriber": {
        "concurrent": 0,
        "enabled": true,
        "limit": true,
        "requests": 0
      },
      "user": {
        "concurrent": 0,
        "enabled": true,
        "limit": true,
        "requests": 0
      }
    }
  },
  "limitAdminRequests": true,
  "limitAnonymousRequests": true,
  "liveLearnsNoSongFound": true,
  "maxRequests": 0,
  "minAmount": 0,
  "minLiveLearnAmount": 0,
  "minTipAmountForQueueOrdering": 0,
  "minTokensForBump": 0,
  "minTokensToIgnoreLimits": 0,
  "minutesBetweenRequests": 0,
  "newDays": 0,
  "permitConfig": {
    "bypasses": [
      "string"
    ],
    "default_duration_seconds": 0,
    "no_expiry": true
  },
  "promoteQueueToPlaying": true,
  "queueOrderMode": "amount",
  "requestMode": "any",
  "requestsActive": true,
  "requestsPerAdmin": 0,
  "requestsPerAnonymous": 0,
  "requestsPerUser": 0,
  "sessionLength": 0,
  "syncPlatformBans": true,
  "trackSongDuration": true
}

Responses

200OK

application/json

Schema

StreamerDetails

$schemastring

A URL to the JSON Schema for this object.

adminBypassRestrictionsbooleanrequired

adminSyncConfigAdminSyncConfigrequired

twitchAdminSyncPlatformConfig

defaultPermissionsAdminPermissions

attributestring

commandstring

historystring

overlaystring

premiumContentstring

queuestring

settingsstring

songstring

enabledbooleanrequired

allowDuplicatesbooleanrequired

allowLiveLearnsbooleanrequired

alwaysShowRequestDialogbooleanrequired

canAnonymousEnterNamebooleanrequired

canAnonymousRequestbooleanrequired

canUserRequestbooleanrequired

concurrentRequestsintegerrequired

concurrentRequestsPerAdminintegerrequired

concurrentRequestsPerAnonymousintegerrequired

concurrentRequestsPerUserintegerrequired

customThemeCustomThemeColorsrequired

accentstringrequired

backgroundstring

darkCustomThemeDarkColors

accentstring

backgroundstring

foregroundstring

primarystring

foregroundstring

primarystringrequired

donationPagestringrequired

donationsIgnoreLimitsbooleanrequired

embedOriginsstringrequired

enableCrossPlatformRequestsbooleanrequired

eventConfigobjectrequired

favoritebooleanrequired

featureConfigFeatureConfigrequired

collabSessionsboolean

durationboolean

globalSongSearchboolean

premiumContentboolean

savedRequestsboolean

songsToLearnboolean

tokensboolean

fixedTokenPricebooleanrequired

homePageConfigobjectrequired

Home page panel configuration

idintegerrequired

integrationSettingsIntegrationSettingsrequired

kickKickIntegrationSettings

botConnectedbooleanrequired

followerRequestTypeSettingsrequired

concurrentintegerrequired

enabledbooleanrequired

limitbooleanrequired

requestsintegerrequired

subscriberRequestTypeSettingsrequired

concurrentintegerrequired

enabledbooleanrequired

limitbooleanrequired

requestsintegerrequired

userRequestTypeSettingsrequired

concurrentintegerrequired

enabledbooleanrequired

limitbooleanrequired

requestsintegerrequired

streamelementsStreamelementsSettings

sendChatMessagebooleanrequired

streamlabsStreamlabsSettings

sendChatMessagebooleanrequired

twitchTwitchStreamerSettings

botConnectedbooleanrequired

followerRequestTypeSettingsrequired

concurrentintegerrequired

enabledbooleanrequired

limitbooleanrequired

requestsintegerrequired

subscriberT1RequestTypeSettingsrequired

concurrentintegerrequired

enabledbooleanrequired

limitbooleanrequired

requestsintegerrequired

subscriberT2RequestTypeSettingsrequired

concurrentintegerrequired

enabledbooleanrequired

limitbooleanrequired

requestsintegerrequired

subscriberT3RequestTypeSettingsrequired

concurrentintegerrequired

enabledbooleanrequired

limitbooleanrequired

requestsintegerrequired

userRequestTypeSettingsrequired

concurrentintegerrequired

enabledbooleanrequired

limitbooleanrequired

requestsintegerrequired

vipRequestTypeSettingsrequired

concurrentintegerrequired

enabledbooleanrequired

limitbooleanrequired

requestsintegerrequired

youtubeYoutubeStreamerSettings

botConnectedbooleanrequired

memberRequestTypeSettingsrequired

concurrentintegerrequired

enabledbooleanrequired

limitbooleanrequired

requestsintegerrequired

membershipLevelsobjectrequired

subscriberRequestTypeSettingsrequired

concurrentintegerrequired

enabledbooleanrequired

limitbooleanrequired

requestsintegerrequired

userRequestTypeSettingsrequired

concurrentintegerrequired

enabledbooleanrequired

limitbooleanrequired

requestsintegerrequired

landingPageContentobjectrequired

Tiptap JSON document content

learnListConfigLearnListConfigrequired

$schemastring

A URL to the JSON Schema for this object.

addQuotaPerUserinteger

maxActiveSongsPerUserinteger

requireApprovalboolean

rewardMapobject

tokensPerVoteinteger

voteWeightsLearnListVoteWeightsrequired

defaultinteger

followerinteger

kickSubscriberinteger

twitchTier1integer

twitchTier2integer

twitchTier3integer

youtubeMemberinteger

limitAdminRequestsbooleanrequired

limitAnonymousRequestsbooleanrequired

liveLearnsNoSongFoundbooleanrequired

maxRequestsintegerrequired

minAmountnumberrequired

minLiveLearnAmountnumberrequired

minTipAmountForQueueOrderingnumberrequired

minTokensForBumpnumberrequired

minTokensToIgnoreLimitsnumberrequired

minutesBetweenRequestsintegerrequired

newAttributeStreamerNewAttribute

idintegerrequired

imagestringrequired

namestringrequired

showbooleanrequired

showSelectorbooleanrequired

newDaysintegerrequired

permitConfigPermitConfigrequired

bypassesstring[]required

Array items:

string

default_duration_secondsintegerrequired

no_expirybooleanrequired

platformsStreamerPlatformsrequired

kickStreamerPlatform

displayNamestringrequired

platformIDstringrequired

profileImageUrlstring

usernamestringrequired

noneStreamerPlatform

displayNamestringrequired

platformIDstringrequired

profileImageUrlstring

usernamestringrequired

twitchStreamerPlatform

displayNamestringrequired

platformIDstringrequired

profileImageUrlstring

usernamestringrequired

youtubeStreamerPlatform

displayNamestringrequired

platformIDstringrequired

profileImageUrlstring

usernamestringrequired

promoteQueueToPlayingbooleanrequired

queueOrderModestringrequired

queuePageConfigQueuePageConfigrequired

publicQueuePageLayout

columnsobject

enabledboolean

nowPlayingstring

rowsQueueSummaryColumn[][]

Array items:

Array of QueueSummaryColumn

QueueSummaryColumn (circular reference)

summaryFirstboolean

streamerQueuePageLayout

columnsobject

enabledboolean

nowPlayingstring

rowsQueueSummaryColumn[][]

Array items:

Array of QueueSummaryColumn

QueueSummaryColumn (circular reference)

summaryFirstboolean

requestModestringrequired

requestTextstringrequired

requestsActivebooleanrequired

requestsPerAdminintegerrequired

requestsPerAnonymousintegerrequired

requestsPerUserintegerrequired

sessionLengthintegerrequired

showDonationLinkbooleanrequired

songListConfigSongListConfigrequired

artistSortIgnorePrefixesstring[]

Array items:

string

titleSortIgnorePrefixesstring[]

Array items:

string

syncPlatformBansbooleanrequired

themestringrequired

tokenConfigTokenConfigrequired

chatSpendKeywordsstring[]

Array items:

string

kickSubinteger

tokenValiditySecondsinteger

tokensPerBitnumber

tokensPerKicknumber

twitchSubTier1integer

twitchSubTier2integer

twitchSubTier3integer

trackSongDurationbooleanrequired

userIdintegerrequired

Example

{
  "$schema": "https://example.com",
  "adminBypassRestrictions": true,
  "adminSyncConfig": {
    "twitch": {
      "defaultPermissions": {
        "attribute": "string",
        "command": "string",
        "history": "string",
        "overlay": "string",
        "premiumContent": "string",
        "queue": "string",
        "settings": "string",
        "song": "string"
      },
      "enabled": true
    }
  },
  "allowDuplicates": true,
  "allowLiveLearns": true,
  "alwaysShowRequestDialog": true,
  "canAnonymousEnterName": true,
  "canAnonymousRequest": true,
  "canUserRequest": true,
  "concurrentRequests": 0,
  "concurrentRequestsPerAdmin": 0,
  "concurrentRequestsPerAnonymous": 0,
  "concurrentRequestsPerUser": 0,
  "customTheme": {
    "accent": "string",
    "background": "string",
    "dark": {
      "accent": "string",
      "background": "string",
      "foreground": "string",
      "primary": "string"
    },
    "foreground": "string",
    "primary": "string"
  },
  "donationPage": "string",
  "donationsIgnoreLimits": true,
  "embedOrigins": "string",
  "enableCrossPlatformRequests": true,
  "eventConfig": {},
  "favorite": true,
  "featureConfig": {
    "collabSessions": true,
    "duration": true,
    "globalSongSearch": true,
    "premiumContent": true,
    "savedRequests": true,
    "songsToLearn": true,
    "tokens": true
  },
  "fixedTokenPrice": true,
  "homePageConfig": null,
  "id": 0,
  "integrationSettings": {
    "kick": {
      "botConnected": true,
      "follower": {
        "concurrent": 0,
        "enabled": true,
        "limit": true,
        "requests": 0
      },
      "subscriber": {
        "concurrent": 0,
        "enabled": true,
        "limit": true,
        "requests": 0
      },
      "user": {
        "concurrent": 0,
        "enabled": true,
        "limit": true,
        "requests": 0
      }
    },
    "streamelements": {
      "sendChatMessage": true
    },
    "streamlabs": {
      "sendChatMessage": true
    },
    "twitch": {
      "botConnected": true,
      "follower": {
        "concurrent": 0,
        "enabled": true,
        "limit": true,
        "requests": 0
      },
      "subscriberT1": {
        "concurrent": 0,
        "enabled": true,
        "limit": true,
        "requests": 0
      },
      "subscriberT2": {
        "concurrent": 0,
        "enabled": true,
        "limit": true,
        "requests": 0
      },
      "subscriberT3": {
        "concurrent": 0,
        "enabled": true,
        "limit": true,
        "requests": 0
      },
      "user": {
        "concurrent": 0,
        "enabled": true,
        "limit": true,
        "requests": 0
      },
      "vip": {
        "concurrent": 0,
        "enabled": true,
        "limit": true,
        "requests": 0
      }
    },
    "youtube": {
      "botConnected": true,
      "member": {
        "concurrent": 0,
        "enabled": true,
        "limit": true,
        "requests": 0
      },
      "membershipLevels": {},
      "subscriber": {
        "concurrent": 0,
        "enabled": true,
        "limit": true,
        "requests": 0
      },
      "user": {
        "concurrent": 0,
        "enabled": true,
        "limit": true,
        "requests": 0
      }
    }
  },
  "landingPageContent": null,
  "learnListConfig": {
    "$schema": "https://example.com",
    "addQuotaPerUser": 0,
    "maxActiveSongsPerUser": 0,
    "requireApproval": true,
    "rewardMap": {},
    "tokensPerVote": 0,
    "voteWeights": {
      "default": 0,
      "follower": 0,
      "kickSubscriber": 0,
      "twitchTier1": 0,
      "twitchTier2": 0,
      "twitchTier3": 0,
      "youtubeMember": 0
    }
  },
  "limitAdminRequests": true,
  "limitAnonymousRequests": true,
  "liveLearnsNoSongFound": true,
  "maxRequests": 0,
  "minAmount": 0,
  "minLiveLearnAmount": 0,
  "minTipAmountForQueueOrdering": 0,
  "minTokensForBump": 0,
  "minTokensToIgnoreLimits": 0,
  "minutesBetweenRequests": 0,
  "newAttribute": {
    "id": 0,
    "image": "string",
    "name": "string",
    "show": true,
    "showSelector": true
  },
  "newDays": 0,
  "permitConfig": {
    "bypasses": [
      "string"
    ],
    "default_duration_seconds": 0,
    "no_expiry": true
  },
  "platforms": {
    "kick": {
      "displayName": "string",
      "platformID": "string",
      "profileImageUrl": "string",
      "username": "string"
    },
    "none": {
      "displayName": "string",
      "platformID": "string",
      "profileImageUrl": "string",
      "username": "string"
    },
    "twitch": {
      "displayName": "string",
      "platformID": "string",
      "profileImageUrl": "string",
      "username": "string"
    },
    "youtube": {
      "displayName": "string",
      "platformID": "string",
      "profileImageUrl": "string",
      "username": "string"
    }
  },
  "promoteQueueToPlaying": true,
  "queueOrderMode": "string",
  "queuePageConfig": {
    "public": {
      "columns": {},
      "enabled": true,
      "nowPlaying": "string",
      "rows": [
        [
          {
            "id": "string",
            "tiles": [
              {
                "id": "string",
                "metric": "string",
                "mode": "string"
              }
            ],
            "width": 0
          }
        ]
      ],
      "summaryFirst": true
    },
    "streamer": {
      "columns": {},
      "enabled": true,
      "nowPlaying": "string",
      "rows": [
        [
          {
            "id": "string",
            "tiles": [
              {
                "id": "string",
                "metric": "string",
                "mode": "string"
              }
            ],
            "width": 0
          }
        ]
      ],
      "summaryFirst": true
    }
  },
  "requestMode": "string",
  "requestText": "string",
  "requestsActive": true,
  "requestsPerAdmin": 0,
  "requestsPerAnonymous": 0,
  "requestsPerUser": 0,
  "sessionLength": 0,
  "showDonationLink": true,
  "songListConfig": {
    "artistSortIgnorePrefixes": [
      "string"
    ],
    "titleSortIgnorePrefixes": [
      "string"
    ]
  },
  "syncPlatformBans": true,
  "theme": "string",
  "tokenConfig": {
    "chatSpendKeywords": [
      "string"
    ],
    "kickSub": 0,
    "tokenValiditySeconds": 0,
    "tokensPerBit": 0,
    "tokensPerKick": 0,
    "twitchSubTier1": 0,
    "twitchSubTier2": 0,
    "twitchSubTier3": 0
  },
  "trackSongDuration": true,
  "userId": 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"
}

404Not Found

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