Song V 2

OpenAPI Schema

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

{
  "properties": {
    "artistImageFileName": {
      "description": "Artist image file name. Combine with `imageBaseUrl` from `/song/options` to build a full URL.",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "artistImageUrls": {
      "description": "Pre-built artist image URLs at standard widths (46, 92, 150, 300px).",
      "nullable": true,
      "properties": {
        "46": {
          "format": "uri",
          "type": "string"
        },
        "92": {
          "format": "uri",
          "type": "string"
        },
        "150": {
          "format": "uri",
          "type": "string"
        },
        "300": {
          "format": "uri",
          "type": "string"
        }
      },
      "readOnly": true,
      "type": "object"
    },
    "artistName": {
      "description": "Artist name.",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "bpm": {
      "description": "Beats per minute.",
      "nullable": true,
      "readOnly": true,
      "type": "integer"
    },
    "durationDisplay": {
      "description": "Human-readable duration (e.g. \"3:45\").",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "durationSeconds": {
      "description": "Duration of the song in seconds.",
      "readOnly": true,
      "type": "integer"
    },
    "id": {
      "description": "TSM v2 song identifier.",
      "readOnly": true,
      "type": "string"
    },
    "lyrics": {
      "description": "Song lyrics.",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "similarityHighlightRegions": {
      "description": "Time regions highlighted when this song is used as a similarity reference.",
      "items": {
        "items": {
          "type": "number"
        },
        "type": "array"
      },
      "readOnly": true,
      "type": "array"
    },
    "title": {
      "description": "Song title.",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "topGenreIds": {
      "description": "The top genre IDs for the song.",
      "items": {
        "type": "string"
      },
      "readOnly": true,
      "type": "array"
    },
    "topMoodIds": {
      "description": "The top mood IDs for the song.",
      "items": {
        "type": "string"
      },
      "readOnly": true,
      "type": "array"
    },
    "type": {
      "enum": [
        "song"
      ],
      "readOnly": true,
      "type": "string"
    },
    "waveFormData": {
      "description": "Compressed waveform data string.",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    }
  },
  "title": "Song (v2)",
  "type": "object"
}