API reference/Audio

Download a finished spot

Download an owned stored MP3. Only identifiers are accepted; callers cannot supply a storage path. Requires the same API key as metadata requests.

GET/api/v1/audio/{slug}/finished/{stationId}/{position}/{length}/download

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
stationIdRequired: integerRange: 0 to 2147483647
positionRequired: integerRange: 1 to 30
lengthRequired: See schema for accepted values.

Response

Authenticated file download (audio/mpeg).

Requests and errors →

REST only

Binary download; use audio metadata/tool resource link and fetch with same API key

Illustrative arguments

{
  "slug": "YOUR_VALUE",
  "stationId": 0,
  "position": 1,
  "length": 15
}

Input schema

{
  "type": "object",
  "properties": {
    "slug": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "pattern": "^[a-z0-9][a-z0-9-]*$"
    },
    "stationId": {
      "type": "integer",
      "minimum": 0,
      "maximum": 2147483647
    },
    "position": {
      "type": "integer",
      "minimum": 1,
      "maximum": 30
    },
    "length": {
      "anyOf": [
        {
          "type": "number",
          "const": 15
        },
        {
          "type": "number",
          "const": 30
        },
        {
          "type": "number",
          "const": 45
        },
        {
          "type": "number",
          "const": 60
        }
      ]
    }
  },
  "required": [
    "slug",
    "stationId",
    "position",
    "length"
  ],
  "additionalProperties": false
}

Response schema

Authenticated binary download: audio/mpeg