Skip to main content
GET
Get a knowledge source's kinds and their completeness
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/synchronized-sources/getKindStates?sourceId= reads one synchronized source the caller can read, as the Console source drawer’s Completeness section shows it. MCP hosts call it through forge_call_operation with operationId getSynchronizedSourceKindStates. It needs knowledge:read. The response is { data: { sourceId, sealed, maximumVerificationAgeHours, kinds }, meta }. Each kind carries:
  • kind and its displayName;
  • status: complete, incomplete or stale, with the reason when it is not complete;
  • failingConditions: every completeness condition it fails now;
  • verifiedAt, verification (ok or failed) and failedChecks;
  • quarantinedCount and recordCount.
A kind that is not complete explains why List knowledge records refuses its records. A source whose first pass has not completed has no kinds yet: follow its progress with List source runs. At most 100 kinds are read; meta.partial is true when the source holds that many. A source that is missing, being removed, or outside the caller’s readable namespaces answers the same 404 resource_missing, so a caller cannot probe for sources it may not read. A Personal key reads as its owner.

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

synchronizedSourceId
string
required

The source's id, from synchronized-sources/list.

Minimum string length: 1

Response

The source's kinds

data
object
required

A synchronized source's kinds, as the Console drawer's Completeness section shows them: whether the source is sealed, the oldest verification it accepts, and per kind its completeness now (complete, incomplete or stale, with the reason), every condition it fails (failingConditions), its last verification and failed checks, its quarantined items and how many records it holds. A source whose first pass has not completed has no kinds yet: records/list refuses its records until one completes.

meta
object
required