Skip to main content
GET
Get a knowledge source
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/get?sourceId=<id> requires knowledge:read. It returns the same redacted source projection as listSynchronizedSources. A malformed, missing, unreadable or being-removed source answers the same 404 resource_missing. Configuration, cursors, external container ids, identity and group mappings, curation, trust weight and creator identity are never returned.

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 id returned by listSynchronizedSources.

Minimum string length: 1

Response

Knowledge source

data
object
required

One knowledge source in a namespace the caller can read: what it connects to (by provider), where it writes, whether it is active, paused or failing, and when it last and next syncs. lastError is redacted. Its configuration, cursor, external container id, identity and group mappings, curation, trust weight and creator are never returned.

meta
object
required