API reference/Audio

List approved audio previews

Try it

List approved station-facing previews for a visible promotion, with authenticated download URLs.

GET/api/v1/audio/{slug}/previews

Authentication

Send your workspace key as xi-api-key or Authorization: Bearer.

audio:readread

Parameters

Named placeholders belong in the path. Other arguments use query parameters.

slugRequired: string

Response

JSON response with status 200.

Requests and errors →

Illustrative arguments

{
  "slug": "YOUR_VALUE"
}

Input schema

{
  "type": "object",
  "properties": {
    "slug": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "pattern": "^[a-z0-9][a-z0-9-]*$"
    }
  },
  "required": [
    "slug"
  ],
  "additionalProperties": false
}

Response schema

{
  "type": "object",
  "properties": {
    "previews": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "position": {
            "type": "number"
          },
          "length": {
            "type": "number"
          },
          "downloadUrl": {
            "type": "string"
          }
        },
        "required": [
          "position",
          "length",
          "downloadUrl"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "previews"
  ],
  "additionalProperties": false
}