List knowledge bases

GET

/api/v1/knowledge/bases

Every knowledge base with its state: documents by status, the serving and building index, this month's spend, and a rebuild's progress (state.build).

Authorization

apiKey

headerAuthorizationBearer <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.

Response Body

Successful Response

application/json

response

[index: integer]?

curl -X GET "https://api.synapseorch.com/api/v1/knowledge/bases" \  -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  }]