inklet docs

Retrieve the confirmed presentation

GET/api/sdk/v1/displays/{displayId}/current-presentation

Returns presentation: null when the display has never confirmed a frame.

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

format?string

Requested rendition on the legacy image field, for display presentations.

Value in

  • "png"
  • "raw2"
  • "raw4"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/sdk/v1/displays/string/current-presentation"
{  "presentation": {    "id": "string",    "displayId": "string",    "contentIds": [      {        "id": "string",        "role": "input"      }    ],    "analysisId": "string",    "mode": "ai",    "title": "string",    "state": "preparing",    "output": {      "formats": [        "scene"      ],      "preset": "string",      "viewport": {        "width": 1,        "height": 1      },      "colorMode": "color",      "pixelRatio": 1    },    "scene": {      "mediaType": "application/vnd.inklet.scene+json;version=1",      "version": 1,      "data": {        "version": 1,        "viewport": {          "width": 1,          "height": 1        },        "background": "string",        "elements": [          {            "id": "string",            "type": "text",            "frame": {              "x": 0,              "y": 0,              "width": 1,              "height": 1            },            "properties": {}          }        ]      }    },    "renditions": [      {        "id": "string",        "mediaType": "image/png",        "format": "png",        "width": 1,        "height": 1,        "colorMode": "color",        "state": "preparing",        "url": "http://example.com",        "expiresAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "failure": {          "code": "string",          "message": "string",          "stage": "string",          "retryable": true,          "assetIndex": 0        }      }    ],    "image": {      "url": "http://example.com",      "format": "png",      "width": 1,      "height": 1,      "expiresAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    },    "failure": {      "code": "string",      "message": "string",      "stage": "string",      "retryable": true,      "assetIndex": 0    },    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}

List a display queue GET

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`.

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.