Knowledge
Get a knowledge base
GET
The base's settings and state.
More in Knowledge API.
apiKeyheader
AuthorizationBearer <token>An API key, sk-syn- and 32 characters. On SynapseOrch Cloud an owner or admin makes it under Settings → Developer; on a self-hosted install, under Settings → API Keys.
kb_id*stringSuccessful Response
application/json- response
id*stringname*stringLength
1 <= length <= 200description?stringLength
length <= 2000Default
""folder*stringstatus?stringDefault
"active"Value in
"active""disabled"language?stringDefault
"simple"visitor_access?booleanDefault
falsebudget_monthly_usd?|nullchunking?embedding?The embedding model. "" means the deployment's default (cloud: Titan v2 1024-d).
rerank?None means the deployment's default: on in cloud, off in OSS unless configured.
fusion?retrieval?enrichment?How passages are given context before they are embedded. prefix is deterministic and free; contextual is Contextual Retrieval, an opt-in behind a cost preview, on any chat model including your own.
web?Per-KB crawl settings, each bounded by the deployment's caps (config.py).
revision?integerRange
1 <= valueDefault
1created_at?stringDefault
""updated_at?stringDefault
""state?reindex_started?booleanDefault
falsecurl -X GET "https://api.synapseorch.com/api/v1/knowledge/bases/kb_01a10d3f5a7c9e1b3d5f7a9c1e3b5d7f" \ -H "Authorization: Bearer sk-syn-..."{ "id": "string", "name": "string", "description": "", "folder": "string", "status": "active", "language": "simple", "visitor_access": false, "budget_monthly_usd": 0, "chunking": { "mode": "structure", "target_tokens": 450, "max_tokens": 800, "overlap_pct": 0 }, "embedding": { "model": "", "dims": 1, "profile": "string" }, "rerank": { "enabled": true, "model": "string", "top_n": 8, "candidates": 50 }, "fusion": { "method": "rrf", "rrf_k": 60, "weights": { "property1": 0, "property2": 0 }, "overfetch": 50 }, "retrieval": { "top_k": 8, "score_threshold": 0, "parent_expansion": "off", "neighbor_window": 1, "max_context_tokens": 6000 }, "enrichment": { "mode": "prefix", "contextual_model": "string", "extract_metadata": false }, "web": { "max_depth": 3, "max_pages": 500, "rps_per_host": 1, "recrawl_days": 7, "sources": [ { "id": "string", "url": "string", "kind": "page", "include": [ "string" ], "exclude": [ "string" ] } ] }, "revision": 1, "created_at": "", "updated_at": "", "state": { "counts_by_status": { "property1": 0, "property2": 0 }, "active_snapshot": "string", "building_snapshot": "string", "month_spend_usd": 0, "paused_reason": "string", "build": { "snapshot_id": "string", "status": "building", "docs_total": 0, "docs_done": 0, "docs_failed": 0, "started_at": "string", "paused_reason": "string", "error": "string", "passages_done": 0, "passages_total": 0, "stage": "parse", "eta_s": 0, "waiting": { "reason": "rate_limited", "provider": "string", "provider_id": "string", "until": "string" } } }, "reindex_started": false}