Skip to main content
GET
Get the knowledge learning settings
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/settings/get returns the knowledge learning settings in force, deployment-wide, as the Console Knowledge › Settings page shows them. It needs knowledge:read. It is the settings section of knowledge health without its scope, for a client that does not need the whole health report. MCP hosts call it through forge_call_operation with operationId getKnowledgeSettings. Who wrote a setting is never returned. The route takes no query parameter; any one answers 400 bad_request. Change a setting with Change a knowledge learning setting.

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.

Response

The learning settings in force

data
object
required

The knowledge learning settings in force, deployment-wide: every value resolved to a valid one, the chat message to long-term memory threshold, which keys carry a stored override (overriddenKeys), a stored value its rule keeps only part of (partlyApplied) or none of (ignoredKeys), and when each stored key was last written.

meta
object
required