Song

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "properties": {
    "artist": {
      "description": "Artist name.",
      "readOnly": true,
      "type": "string"
    },
    "duration": {
      "description": "Duration of the song, in seconds.",
      "readOnly": true,
      "type": "integer"
    },
    "id": {
      "$ref": "#/components/schemas/Id"
    },
    "instruments": {
      "description": "The instruments featured in the song.",
      "items": {
        "type": "string"
      },
      "readOnly": true,
      "type": "array"
    },
    "isInstrumental": {
      "description": "Whether the track is an instrumental or vocal track.",
      "readOnly": true,
      "type": "boolean"
    },
    "lyrics": {
      "description": "The lyrics for this song.",
      "readOnly": true,
      "type": "string"
    },
    "media": {
      "description": "The media URLs for the different streams and files.",
      "properties": {
        "artistThumbnailUrl": {
          "format": "uri",
          "readOnly": true,
          "type": "string"
        },
        "fullStreamUrl": {
          "format": "uri",
          "readOnly": true,
          "type": "string"
        },
        "sampleStreamUrl": {
          "format": "uri",
          "readOnly": true,
          "type": "string"
        }
      },
      "type": "object"
    },
    "moods": {
      "description": "The moods describing the song.",
      "items": {
        "type": "string"
      },
      "readOnly": true,
      "type": "array"
    },
    "styles": {
      "description": "The styles describing the song.",
      "items": {
        "type": "string"
      },
      "readOnly": true,
      "type": "array"
    },
    "tempo": {
      "description": "Tempo of the song.",
      "enum": [
        "fast",
        "medium",
        "slow"
      ],
      "readOnly": true,
      "type": "string"
    },
    "themes": {
      "description": "The themes describing the song.",
      "items": {
        "type": "string"
      },
      "readOnly": true,
      "type": "array"
    },
    "title": {
      "description": "Song title.",
      "readOnly": true,
      "type": "string"
    },
    "type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Type"
        },
        {
          "enum": [
            "song"
          ]
        }
      ]
    }
  },
  "title": "Song",
  "type": "object"
}