Skip to main content
GET
List knowledge sources
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/list requires knowledge:read. It returns readable sources newest first, across every readable namespace or the optional namespace. limit is 1–100 and defaults to 100. While meta.hasMore is true, pass meta.nextCursor as cursor; a page may contain fewer rows than limit while more remain. An unreadable namespace answers 403 forbidden. Each source reports its id, name, provider key, namespace, target type, sync mode and status, schedule, recent sync times, failure count and redacted last error. Configuration, cursors, container ids, identity mappings, curation, trust weight and creators are never returned. Connect a source with Connect a knowledge source and remove one with Remove a knowledge source.

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.

Query Parameters

namespace
string

One readable knowledge namespace. An unreadable namespace answers 403.

Minimum string length: 1
limit
integer
default:100

Items per page, 1 to 100 (default 100); 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 <= 100
cursor
string

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

Minimum string length: 1

Response

Readable knowledge sources

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.