Skip to main content
GET
List where a knowledge case was used
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

GET /api/v2/knowledge/cases/listUses?entryId=<id>&limit=<n> lists the workflow runs (kind: "run") and chat turns (kind: "chat") in which an agent retrieved and cited the case, newest first, a page at a time (limit 1–50, default 20). Each use carries the agent, the run and node for a run, the latest outcome signal from each source, the signal that counts for the case, and the case version the agent read. It needs knowledge:read. A chat turn’s session, the turn and the retrieval record are never named. A deleted case keeps its uses. A malformed, missing, unreadable or source-restricted case answers 404 resource_missing. While meta.hasMore is true, pass meta.nextCursor as cursor (with the same entryId) for the next page. A page may hold fewer uses than limit while more remain; the list never answers meta.partial.

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

caseId
string
required

The case id (id from listKnowledgeCases).

Minimum string length: 1

Query Parameters

limit
integer
default:20

Items per page, 1 to 50 (default 20); a larger value is a 400 too_big. A page may hold fewer items than limit while meta.hasMore is true; continue with meta.nextCursor.

Required range: 1 <= x <= 50
cursor
string

The previous page's meta.nextCursor; any other value is 400.

Minimum string length: 1

Response

Uses of the case

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.