Ingest records

POST

/api/v1/knowledge/bases/{kb_id}/records

Text or JSON records, each with metadata, stored as <folder>/_records/<id>.json; sending an id again replaces its record. 202, with each document queued.

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.

Path Parameters

kb_id*string

Request Body

application/json

body

records*array<>

Items1 <= items <= 100

Response Body

Successful Response

application/json

response

documents*array<>

curl -X POST "https://api.synapseorch.com/api/v1/knowledge/bases/kb_01a10d3f5a7c9e1b3d5f7a9c1e3b5d7f/records" \  -H "Authorization: Bearer sk-syn-..." \  -H "Content-Type: application/json" \  -d '{    "records": [      {}    ]  }'

{  "documents": [    {      "id": "string",      "kb_id": "string",      "path": "string",      "source": "upload",      "source_url": "string",      "status": "queued",      "status_reason": "string",      "error": "string",      "version": 0,      "sha256": "string",      "size_bytes": 0,      "mime": "string",      "title": "string",      "doc_date": "string",      "metadata": {},      "pages": 0,      "chunks": 0,      "tokens": 0,      "created_at": "string",      "updated_at": "string",      "indexed_at": "string",      "progress": {        "stage": "parse",        "done": 0,        "total": 0,        "unit": "pages",        "eta_s": 0,        "waiting": {          "reason": "rate_limited",          "provider": "string",          "provider_id": "string",          "until": "string"        },        "updated_at": "string"      }    }  ]}