AviatoAviato
DeveloperAPI ReferenceItemsItemidPlayback queue

/api/items/{itemId}/playback-queue

GET
/api/items/{itemId}/playback-queue

Path Parameters

itemId*string

Seed item ID — the queue is built around this item.

Query Parameters

after?string

Cursor — return items strictly after this id in natural order. Used by lazy refill.

limit?integer

Maximum items to return. Eager strategies ignore this; lazy clamps to it. Default 50.

Range0 < value <= 200
entityId?string

Optional source entity id (album / season / show). When provided, the server skips kind-detection on the seed and traverses siblings of this entity directly. Required for lazy refill across season boundaries.

Response Body

application/json

application/json

curl -X GET "https://example.com/api/items/string/playback-queue"
{
  "items": [
    {
      "id": "string",
      "libraryId": "string",
      "title": "string",
      "metadata": {
        "property1": null,
        "property2": null
      },
      "certification": "string",
      "status": "active",
      "addedAt": "string",
      "updatedAt": "string",
      "files": [
        {
          "id": "string",
          "libraryId": "string",
          "uri": "string",
          "filename": "string",
          "extension": "string",
          "fileInfo": {
            "property1": null,
            "property2": null
          },
          "mimeType": "string",
          "type": "media",
          "classification": "string",
          "itemId": "string",
          "status": "active",
          "edition": "string",
          "partNumber": 0,
          "size": 0,
          "duration": 0,
          "createdAt": "string",
          "updatedAt": "string",
          "assets": {
            "property1": "string",
            "property2": "string"
          },
          "assetAspects": {
            "property1": "string",
            "property2": "string"
          },
          "mediaKind": "video",
          "chapters": [
            {
              "id": "string",
              "fileId": "string",
              "startTime": 0,
              "endTime": 0,
              "role": "intro",
              "title": "string",
              "source": "string",
              "metadata": {
                "property1": null,
                "property2": null
              },
              "createdAt": "string",
              "updatedAt": "string",
              "assets": {
                "property1": "string",
                "property2": "string"
              }
            }
          ]
        }
      ],
      "assets": {
        "property1": "string",
        "property2": "string"
      },
      "assetAspects": {
        "property1": "string",
        "property2": "string"
      },
      "linkedEntities": [
        {
          "id": "string",
          "type": "string",
          "name": "string",
          "role": "string",
          "sortOrder": 0,
          "linkMetadata": {
            "property1": null,
            "property2": null
          },
          "assets": {
            "property1": "string",
            "property2": "string"
          },
          "assetAspects": {
            "property1": "string",
            "property2": "string"
          }
        }
      ],
      "playback": {
        "completed": true,
        "position": 0,
        "duration": 0
      },
      "fileId": "string"
    }
  ],
  "context": {
    "kind": "album",
    "sourceId": "string",
    "libraryId": "string"
  },
  "strategy": "eager",
  "style": "panel",
  "autoplay": true,
  "hasMore": true,
  "cursor": "string"
}
{
  "error": "string"
}