Songlist API

Version: 2.0.0

Export

Download

Download JSON Download YAML

Copy URL

post/overlays

Create overlay

Authorization

Required scopes

streamer.overlay.writeWrite streamer overlays

Request Bodyrequired

application/json

Schema

CreateOverlayInput

$schemastring

A URL to the JSON Schema for this object.

canvasOverlayCanvasrequired

backgroundColorstringrequired

sizeElementSizerequired

heightnumberrequired

widthnumberrequired

created_from_idstring

custom_cssstring

elementsunknown[]required

Array items:

unknown

is_publicbooleanrequired

namestringrequired

streamerIdintegerrequired

The streamer's ID. Can be found using the GET /streamers endpoint with the streamer_name and platform parameters

Example

{
  "$schema": "https://example.com",
  "canvas": {
    "backgroundColor": "string",
    "size": {
      "height": 0,
      "width": 0
    }
  },
  "created_from_id": "string",
  "custom_css": "string",
  "elements": [
    null
  ],
  "is_public": false,
  "name": "string",
  "streamerId": 1
}

Responses

200OK

application/json

Schema

Overlay

$schemastring

A URL to the JSON Schema for this object.

canvasOverlayCanvasrequired

backgroundColorstringrequired

sizeElementSizerequired

heightnumberrequired

widthnumberrequired

createdAtstringrequired

createdFromIdstringrequired

customCssstringrequired

elementsunknown[]required

Array items:

unknown

idstringrequired

isPublicbooleanrequired

languagestringrequired

namestringrequired

streamerIdintegerrequired

updatedAtstringrequired

Example

{
  "$schema": "https://example.com",
  "canvas": {
    "backgroundColor": "string",
    "size": {
      "height": 0,
      "width": 0
    }
  },
  "createdAt": "2024-01-01T00:00:00Z",
  "createdFromId": "string",
  "customCss": "string",
  "elements": [
    null
  ],
  "id": "string",
  "isPublic": true,
  "language": "string",
  "name": "string",
  "streamerId": 0,
  "updatedAt": "2024-01-01T00:00:00Z"
}

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