inklet docs

Advance to the next queued presentation

POST/api/sdk/v1/displays/{displayId}/advance

Rotates to the next queued presentation, highest priority first and oldest first within a priority. An empty queue answers 200 with changed: false and changes nothing — that is a normal result, not an error.

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

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/sdk/v1/displays/string/advance"
{  "display": {    "id": "string",    "hardwareId": "string",    "thingName": "string",    "name": "string",    "nickname": "string",    "firmware": "string",    "batteryPercent": 0,    "online": true,    "lastSeenAt": "2019-08-24T14:15:22Z",    "stateUpdatedAt": "2019-08-24T14:15:22Z",    "boundAt": "2019-08-24T14:15:22Z",    "tags": [      "string"    ],    "syncIntervalMinutes": 0,    "nextSyncAt": "2019-08-24T14:15:22Z",    "currentPresentationId": "string",    "currentPresentationUpdatedAt": "2019-08-24T14:15:22Z",    "pendingPresentationId": "string",    "capabilities": {      "pixelWidth": 1,      "pixelHeight": 1,      "orientation": "string",      "colorMode": "string",      "supportedImageContentTypes": [        "string"      ],      "supportedOutputFormats": [        "png"      ]    }  },  "changed": true}

Put a presentation on the panel POST

Activates a presentation that has already been delivered to this display and finished rendering. An `expired` one can be reactivated, which is how "go back to the previous image" works. The frame that was on the panel becomes `expired` rather than going back into the queue. The switch lands on `pendingPresentationId`; `currentPresentationId` follows once the panel confirms. No AI runs and no push quota is consumed.

List contents GET

Next Page