inklet docs

List a display queue

GET/api/sdk/v1/displays/{displayId}/queue

Returns the presentations still waiting to go on the panel, oldest first within a priority. A presentation that has been delivered leaves the queue — for the display's full history, use GET /presentations with displayId.

Authorization

bearerAuth
AuthorizationBearer <token>

A personal access token created in the inklet portal. Server-side use only.

In: header

Path Parameters

displayId*string
Length1 <= length

Query Parameters

cursor?string

Opaque cursor returned by the previous page.

Length1 <= length
limit?integer

Number of items to return.

Range1 <= value <= 50
Default20
from?string

Inclusive lower timestamp bound.

Formatdate-time
to?string

Inclusive upper timestamp bound; must not be earlier than from.

Formatdate-time

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/sdk/v1/displays/string/queue"
{  "nextCursor": "string",  "hasMore": true,  "items": [    {      "id": "string",      "displayId": "string",      "contentIds": [        {          "id": "string",          "role": "input"        }      ],      "analysisId": "string",      "mode": "ai",      "state": "preparing",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ]}