inklet docs

Retrieve the run archive

GET/api/sdk/v1/analyses/{analysisId}/archive

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.

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

analysisId*string
Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/sdk/v1/analyses/string/archive"
{  "url": "http://example.com",  "expiresAt": "2019-08-24T14:15:22Z"}

Stream analysis events GET

The same public events as `GET /analyses/{analysisId}/events`, delivered as `text/event-stream`. Each frame carries the event's `seq` as its SSE `id` and its `type` as the SSE `event`, so a dropped connection resumes with `Last-Event-ID` — or with `after`, which wins when both are present. A `: ping` comment keeps the connection alive. The stream closes with an `end` frame once the analysis is terminal: `{"state": "completed" | "failed", "lastSeq": <int>}`. Rendering and delivery happen after that, so `render.*` and `delivery.*` events are only visible in the paged read.

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.