inklet docs

Stream analysis events

GET/api/sdk/v1/analyses/{analysisId}/events/stream

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.

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

Query Parameters

after?integer

Resume after this seq. Takes precedence over Last-Event-ID.

Range0 <= value <= 2147483647

Header Parameters

Last-Event-ID?string

Standard SSE resume header.

Response Body

text/event-stream

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/sdk/v1/analyses/string/events/stream"
"string"