inklet docs

Retrieve a presentation

GET/api/sdk/v1/presentations/{presentationId}

Readable by id whatever the plan's history depth allows — the window only applies to listing.

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

presentationId*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/presentations/string"
{  "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 presentations GET

Lists generated presentations, display presentations, or both. `displayId` reads one panel's history and implies `scope=display` when `scope` is omitted; combining it with `scope=generated` is a `400`, because a generated presentation has no target display. How far back the display half reaches depends on the plan. `historyWindowStart` reports that floor: rows created before it are left out rather than the request being refused, and it is `null` when nothing was clipped.

Render a stored scene again POST

Rasterises the presentation's stored scene at another size or color mode. No AI runs and the scene itself is never changed.