API reference/Audio

List finished spots

Try it

Page through stored finished spots for a promotion, including stale-master status and authenticated download URLs.

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

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
limitOptional: integerRange: 1 to 100
offsetOptional: integerRange: 0 to 100000
stationIdOptional: integerRange: 0 to 2147483647

Response

JSON response with status 200.

Requests and errors →

Illustrative arguments

{
  "slug": "YOUR_VALUE",
  "limit": 50,
  "offset": 0,
  "stationId": 0
}

Input schema

{
  "type": "object",
  "properties": {
    "slug": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "pattern": "^[a-z0-9][a-z0-9-]*$"
    },
    "limit": {
      "default": 50,
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "type": "integer",
      "minimum": 0,
      "maximum": 100000
    },
    "stationId": {
      "type": "integer",
      "minimum": 0,
      "maximum": 2147483647
    }
  },
  "required": [
    "slug"
  ],
  "additionalProperties": false
}

Response schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stationId": {
            "type": "number"
          },
          "position": {
            "type": "number"
          },
          "length": {
            "type": "number"
          },
          "stale": {
            "type": "boolean"
          },
          "downloadUrl": {
            "type": "string"
          }
        },
        "required": [
          "stationId",
          "position",
          "length",
          "stale",
          "downloadUrl"
        ],
        "additionalProperties": false
      }
    },
    "limit": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "hasMore": {
      "type": "boolean"
    }
  },
  "required": [
    "items",
    "limit",
    "offset",
    "hasMore"
  ],
  "additionalProperties": false
}