Song Options

OpenAPI Schema

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

{
  "properties": {
    "artists": {
      "description": "Available artist filter options.",
      "items": {
        "type": "string"
      },
      "readOnly": true,
      "type": "array"
    },
    "genres": {
      "description": "Available genre filter options.",
      "items": {
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "readOnly": true,
      "type": "array"
    },
    "imageBaseUrl": {
      "description": "Base URL used to construct artist and playlist image URLs.",
      "format": "uri",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "instruments": {
      "description": "Available instrument filter options.",
      "items": {
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "readOnly": true,
      "type": "array"
    },
    "languageId": {
      "description": "Language identifier for the returned options.",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "moods": {
      "description": "Available mood filter options.",
      "items": {
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "readOnly": true,
      "type": "array"
    },
    "playlists": {
      "description": "Available curated playlist filter options.",
      "items": {
        "properties": {
          "category": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "imageFileName": {
            "type": "string"
          },
          "imageUrls": {
            "description": "Pre-built playlist image URLs at standard widths (46, 92, 150, 300px).",
            "properties": {
              "46": {
                "format": "uri",
                "type": "string"
              },
              "92": {
                "format": "uri",
                "type": "string"
              },
              "150": {
                "format": "uri",
                "type": "string"
              },
              "300": {
                "format": "uri",
                "type": "string"
              }
            },
            "type": "object"
          },
          "name": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "readOnly": true,
      "type": "array"
    },
    "themes": {
      "description": "Available theme filter options.",
      "items": {
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "readOnly": true,
      "type": "array"
    },
    "type": {
      "enum": [
        "song-options"
      ],
      "readOnly": true,
      "type": "string"
    },
    "vocalTypes": {
      "description": "Available vocal/instrumental type filter options.",
      "items": {
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "readOnly": true,
      "type": "array"
    }
  },
  "title": "Song Options",
  "type": "object"
}