Analysis events

An Analysis publishes an ordered stream of events: what the agent was given, what it is working on, what it planned, and how the result was rendered and delivered.

import { describeEvent } from "@inklethq/sdk";

const analysis = await inklet.analyze({ contentIds: [content.id] });

for await (const event of inklet.analyses.watch(analysis.id)) {
  console.log(describeEvent(event));
}

The event types

A public reader returns exactly these sixteen types, and nothing else.

AnalysisEventType is that closed union widened with (string & {}), so a type this SDK has never seen still parses rather than failing the stream. A backend that starts publishing a new type does not break an older SDK.

The envelope

Every event carries the same fields, whatever its type.

type AnalysisEvent = {
  seq: number;
  at: string;
  /** Which execution attempt produced the event; a retry restarts the agent. */
  attempt: number;
  source: "agent" | "backend";
  type: AnalysisEventType;
  level: "info" | "warn" | "error";
  /** A displayable one-line English summary, generated by the service. */
  summary: string;
  /** Structured, type-specific fields. Empty when the event carries none. */
  data: Record<string, unknown>;
};

at is always UTC with millisecond precision — 2026-09-14T10:00:05.120Z. summary is English; there is no locale option, and no field carries the agent's own text.

Payloads

data is typed per event type. type is open, so TypeScript cannot use it as a discriminant on its own; isAnalysisEvent() narrows the event and its payload together.

import { isAnalysisEvent } from "@inklethq/sdk";

if (isAnalysisEvent(event, "plan.accepted")) {
  console.log(event.data.presentationIds);
}

The SDK types the fields each event is defined to carry and passes every other field through untouched, so a payload that gains a field still reads. analysis.created, analysis.dispatched, and analysis.leased are typed as open records — the fields above are what the service sends today, not a shape the SDK narrows for you.

context.materialized

Counts of what the agent was given to work with: contents named by the Analysis, history retrieved from the user's earlier Contents, displays, and templates — the layouts available to choose from. bytes is the size of the materialized workspace, vision is true when at least one image was included, and warnings is present, with level: "warn", when something was degraded.

plan.rejected

A rejected plan is not a failed run. The agent corrects it and submits again, and the Analysis never leaves running. The problem sentences themselves are internal; the count and the reason are the public shape, and reason describes the first problem found.

analysis.lease_expired

A worker's lease ran out before it returned a result. This reads like the end and is not: the attempt is abandoned, the run is handed back out, and the agent starts again from the top. The event is warn, the Analysis stays running, and the next analysis.leased carries attempt + 1. Two of these followed by another analysis.leased means "retried twice, still going" — not a run to tell anyone to retry.

agent.activity

A run of related agent steps arrives as one activity rather than one event per step. This is the public shape of agent progress; individual tool calls are not published.

chosen: null means the agent looked at layouts but has not settled on one. Every stats field is absent rather than 0 when it does not apply: "read no notes" and "this kind of activity does not count notes" are two different statements.

Merging

The same activity is re-emitted as it progresses — throttled active updates, then a final done or failed — so a raw list renders the same row over and over. Upsert by attempt and activityId together, or hand the list to mergeActivities():

import { describeEvent, mergeActivities } from "@inklethq/sdk";

const rows = mergeActivities(events).map(describeEvent);
// "Ready · 3 Contents, 1 Display, 9 layouts"
// "Read 4 notes"
// "Chose Daily Summary"
// "Submitted the plan · 2 actions"

Each activity keeps the position of its first appearance, so the order still reads as the order things started, and every other event passes through untouched.

describeEvent()

describeEvent(event: AnalysisEvent): string

One English line, read from type and data, falling back to the backend's summary when there is nothing better to say. agent.activity is the reason it exists: it is the one public type the backend writes no sentence for, because what it means depends on counters that change while the activity runs.

It is pure and English-only, and nothing in the SDK branches on the strings it returns — they are display copy, and they change.

Values added after your SDK version still get a line: an activity kind it does not know is described from its step count, like other; an activity state it does not know reads as still running; and a rejection reason it does not know gets the generic "sent back" sentence. The same goes for source and level on every event — a value this SDK has not seen arrives as its own string.

Reading the stream

watch(analysisId: string, options?: WatchAnalysisOptions): AsyncIterable<AnalysisEvent>

timeline(analysisId: string, options?: TimelineOptions): AsyncIterable<AnalysisEvent>

listEvents(analysisId: string, options?: ListAnalysisEventsOptions): Promise<AnalysisEventPage>

Transport

watch() handles the transport, and you receive the same events either way:

• It reads server-sent events and resumes from the last seq with Last-Event-ID when the connection drops, or when reconnecting is answered with 408, 429, 500, 502, 503, or 504 — five attempts, exponential back-off capped at 30 seconds, never sooner than Retry-After — so nothing is lost across a reconnect.
• If the response is not text/event-stream, which is what an intermediate proxy that cannot carry streaming responses returns, it falls back to polling listEvents() every pollIntervalMs until the Analysis is terminal.
• signal stops it with OperationAbortedError, even mid-read of an open stream. Breaking out of the for await loop closes the connection.

Relaying to a browser

The SDK is server-only: a personal access token must never reach a browser. Run watch() on your server and relay events to the client over your own channel.

Merge on whichever side owns the list — on the browser side that is an upsert keyed by attempt and activityId, so a late active update never appends a second row and a retry never overwrites the attempt before it:

function apply(rows: Map<string, string>, event: AnalysisEvent) {
  const key = isAnalysisEvent(event, "agent.activity")
    ? `${event.attempt}:${event.data.activityId}`
    : String(event.seq);

  rows.set(key, describeEvent(event));
}

In browser code, read that relay with fetch plus ReadableStream rather than EventSource. EventSource cannot set request headers, cannot send a body, and gives you no access to the response status or content type — so it cannot tell a real stream from one a proxy has downgraded, which is exactly the case the fallback above exists for.