2 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

AudioSearchFilters — openapi

Audio-specific search filter parameters.

Properties

NameTypeRequiredDescription
audioTypesarrayfalseAudio types to include (e.g. Music, SoundEffect)
minDurationSecondsintegerfalseThe minimum duration for audio in seconds. If included, must be greater than or equal to 0.
maxDurationSecondsintegerfalseThe maximum duration for audio in seconds. If included, must be greater than or equal to 1.
artiststringfalseThe name of the artist to filter by.
albumstringfalseThe name of the album to filter by.
musicChartTypefalseIndicates which music charts to filter from.

Complete Schema

{
  "type": "object",
  "properties": {
    "audioTypes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SearchAudioTypeModel"
      },
      "description": "Audio types to include (e.g. Music, SoundEffect)",
      "nullable": true
    },
    "minDurationSeconds": {
      "maximum": 2147483647,
      "minimum": 0,
      "type": "integer",
      "description": "The minimum duration for audio in seconds. If included, must be greater than or equal to 0.",
      "format": "int32"
    },
    "maxDurationSeconds": {
      "maximum": 2147483647,
      "minimum": 1,
      "type": "integer",
      "description": "The maximum duration for audio in seconds. If included, must be greater than or equal to 1.",
      "format": "int32",
      "nullable": true
    },
    "artist": {
      "type": "string",
      "description": "The name of the artist to filter by.",
      "nullable": true
    },
    "album": {
      "type": "string",
      "description": "The name of the album to filter by.",
      "nullable": true
    },
    "musicChartType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MusicChartType"
        }
      ],
      "description": "Indicates which music charts to filter from.",
      "x-enumNames": [
        "None",
        "Current",
        "Week",
        "Month",
        "Year"
      ],
      "x-enum-varnames": [
        "None",
        "Current",
        "Week",
        "Month",
        "Year"
      ]
    }
  },
  "additionalProperties": false,
  "description": "Audio-specific search filter parameters.",
  "nullable": true
}