inklet docs

List presentations

GET/api/sdk/v1/presentations

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.

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Query Parameters

cursor?string

Opaque cursor returned by the previous page.

Length1 <= length
limit?integer

Number of items to return.

Range1 <= value <= 50
Default20
scope?string

Defaults to generated, or to display when displayId is given.

Value in

  • "generated"
  • "display"
  • "all"
displayId?string

Keep only presentations targeted at this display.

Length1 <= length
state?string

preparing and failed apply to both kinds. ready is the terminal state of a generated presentation; queued, published, confirmed, and expired describe a display presentation's delivery.

Value in

  • "preparing"
  • "ready"
  • "queued"
  • "published"
  • "confirmed"
  • "expired"
  • "failed"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/sdk/v1/presentations"
{  "nextCursor": "string",  "hasMore": true,  "items": [    {      "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"    }  ],  "historyWindowStart": "2019-08-24T14:15:22Z"}

Retrieve the run archive GET

A short-lived download URL for the analysis run archive. Answers `404` with `archive_not_found` while the run is in progress, or after retention has expired.

Retrieve a presentation GET

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