List a base's documents

GET

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

Paged by after (the last id seen) and limit; narrowed by status or path_prefix. A document being read or indexed carries progress: its stage, how much is done, the time left, and any rate limit it is waiting out.

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

Query Parameters

after?string|null

limit?integer

Range1 <= value <= 1000

Default100

status?string|null

path_prefix?string|null

Response Body

Successful Response

application/json

response

[index: integer]?

curl -X GET "https://api.synapseorch.com/api/v1/knowledge/bases/kb_01a10d3f5a7c9e1b3d5f7a9c1e3b5d7f/documents" \  -H "Authorization: Bearer sk-syn-..."

[  {    "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"    }  }]