Skip to main content
GET
List the knowledge scopes an agent reads
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/agents/listReadableScopes?id=<agentId> lists the knowledge namespaces one agent reads outside any run, as the Console’s agent Knowledge tab shows them.

Authority

You need agents:read at the agent’s home org unit and knowledge:read. A missing, PERSONAL, unhomed or unreadable agent is the same 404 resource_missing (Agent not found); an unavailable store is 500. id is required once.

What it returns

{ scopes, hiddenCount }. scopes lists the agent’s namespaces (global, company, its own and its team’s) that your credential may read too, each as { namespace, scopeType, entityId? }. The others are counted in hiddenCount, never named. A run adds its own factory and project scopes.

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

agentId
string
required

The agent's slug (agentId) or definition id.

Minimum string length: 1

Query Parameters

limit
integer

Items per page, 1 to 1000; a larger value is a 400 too_big. Omitted, the page is the whole list. The list is read whole.

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

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

Minimum string length: 1

Response

List the knowledge scopes an agent reads

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.