Song V 2 Collection

OpenAPI Schema

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

{
  "properties": {
    "items": {
      "description": "List of songs.",
      "items": {
        "$ref": "#/components/schemas/SongV2"
      },
      "readOnly": true,
      "type": "array"
    },
    "meta": {
      "properties": {
        "isFailedSearch": {
          "description": "Whether the search fell back to a broader result set.",
          "readOnly": true,
          "type": "boolean"
        },
        "totalRows": {
          "description": "Total number of matching songs.",
          "readOnly": true,
          "type": "integer"
        }
      },
      "type": "object"
    },
    "similarityRow": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SongV2"
        }
      ],
      "description": "The anchor song used for similarity search, if applicable.",
      "nullable": true,
      "readOnly": true
    },
    "type": {
      "enum": [
        "song-collection"
      ],
      "readOnly": true,
      "type": "string"
    }
  },
  "title": "Collection of songs (v2)",
  "type": "object"
}