Skip to main content
GET
Resolve a run's knowledge citation
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 the knowledge case (entryId) a [ref:k…] citation in the run’s conversation names, among the cases the run cited or retrieved. Open it with GET /api/v2/knowledge/cases/get. It records nothing.

Who may resolve a citation

You also need knowledge:read: without it in your scopes or role grants the call answers 403. The case must be one your knowledge scope opens, read as no particular person: an active case in a namespace you read, whose source access does not limit it to named people. A ref no case matches, two cases share, or a case you could not open answers 404 “Citation not found”, so the answer never names a case you cannot read.

Visibility

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

ref
string
required

The citation ref, such as k1a2b3c4.

Minimum string length: 1

Response

The cited case

data
object
required
meta
object
required