Skip to main content
GET
List the messages of a run's AI analysis
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

Returns one page of a run’s AI analysis conversation, oldest first. A run without an analysis answers 404 “Analysis not found”. Each message has its id, its order (a turn’s messages share one) and stepOrder within the turn, its role (system, user or assistant; tool results arrive inside the assistant message’s toolCalls), its status, its text, the agentName that wrote it, its reasoning, and its toolCalls (each a toolName, its input, its output or error text, and the AI SDK state). Credential-shaped strings (JWTs, Bearer tokens, x-access-token: URLs and GitHub tokens) are replaced by a [REDACTED] marker. Never the agent thread, who wrote the message, or the message’s raw parts or metadata.

Paging

limit is 1 to 50 (default 20). A turn’s messages share an order, so one turn may span two pages. A page may be shorter than limit while meta.hasMore is true; follow meta.nextCursor until it is false. A cursor the server cannot read answers 400.

Authority

You need workflows:read at the platform scope, the key the Console’s analysis reads use, and your scopes must also reach runs:read. Either missing answers a recorded 403 naming it. A key with workflows:read only at an org unit is refused, and so is one holding platform:manage without workflows:read. Starting an analysis with POST /api/v2/runs/startAnalysis still needs platform:manage. You need runs:read at the run’s home (its own org unit, else its workflow’s owning org unit) and at every company it carries, the same rule as GET /api/v2/runs/get. Any other run, and a run with neither home, answers 404 “Run not found” like a missing one. A Personal key reads as its owner, cut down to the key’s scopes; an External App reads by its own role grants.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Path Parameters

runId
string
required

The run id.

Minimum string length: 1

Query Parameters

cursor
string

The opaque meta.nextCursor from the previous page.

Minimum string length: 1
limit
integer
default:20

Rows per page, 1-50. Default 20.

Required range: 1 <= x <= 50

Response

One page of the analysis's messages

data
object[]
required
meta
object
required

A list page's continuation. While hasMore is true, nextCursor is a string: pass it as cursor for the next page. hasMore: false ends the list; with truncated: true, more exist past what this list reads, and no cursor reaches them.