Skip to main content
GET
Stream a query turn's events (SSE)

Authorizations

Authorization
string
header
required

Session token from POST /auth/login. Pass as Authorization: Bearer <token>. The alternative X-Pinecone-Api-Key header is also accepted for direct-key auth (used by the Nexus CLI on first contact).

Headers

Last-Event-ID
string

Resume from this event seq; delivery is inclusive of the given id (re-sending the last event is harmless — clients merge steps idempotently by step_id).

X-Pinecone-Api-Version
string
default:2026-07

Date-based contract version. Omit to resolve to the Nexus default version (2026-07, the oldest served version); send unstable for the in-development surface. The resolved version is echoed back on the same header. A present-but-unrecognized value is rejected with 400 unsupported_api_version.

Path Parameters

id
string
required

Response

SSE event stream; each event: name is the event type and data: is its JSON payload.

Server-sent event stream. While the turn runs, each progress frame has an id: (the event's sequence number — send it back as the Last-Event-ID header to resume), an event: name equal to the QueryEvent type (e.g. response.step), and that QueryEvent as its JSON data:. When the turn finishes, a final frame named event: query is sent — no id:, with the full Query document as data:.

type
string
required
query_id
string
required
session_id
string

response.created

delta
string

response.output_text.delta

error
string

response.failed / response.cancelled

trace_ref
string

response.trace

step_id
string

response.step

status
string

response.step (running/completed/failed), response.synthesis (completed)

commentary
string

response.step

fns
string[]

response.step

code
string

response.step

cum_input_tokens
integer<int64>

response.step

cum_output_tokens
integer<int64>

response.step

n_steps
integer<int64>

response.turn_rollup

n_tool_calls
integer<int64>

response.turn_rollup

by_category
object

response.turn_rollup

total_hits
integer<int64>

response.turn_rollup

duration_ms
integer<int64>

response.turn_rollup

cache_read_tokens
integer<int64>

response.turn_rollup

cache_write_tokens
integer<int64>

response.turn_rollup

tokens_in
integer<int64>

response.synthesis

tokens_out
integer<int64>

response.synthesis

ms
integer<int64>

response.synthesis

answer_preview
string

response.synthesis

tokens_in_cached
integer<int64>

response.synthesis

tokens_in_cache_write
integer<int64>

response.synthesis

tokens_in_fresh
integer<int64>

response.synthesis