Documentation Index
Fetch the complete documentation index at: https://orbit-docs.devotel.io/llms.txt
Use this file to discover all available pages before exploring further.
Knowledge Bases API
Upload documents (PDFs, Word, plain text, web pages) into per-tenant vector stores. AI agents query these stores at run time to ground their responses. Each knowledge base is an independent index — you’d typically have one per topic (“Product manuals”, “HR policies”, “Refund flow”).
Base path: /v1/knowledge-bases
Authentication: API key (X-API-Key) or session JWT.
Upload limits: 10 MB per document. PDF, DOCX, TXT, MD, and HTML supported.
Knowledge bases
| Method | Path | Purpose |
|---|
GET | /v1/knowledge-bases | List knowledge bases |
POST | /v1/knowledge-bases | Create a knowledge base |
GET | /v1/knowledge-bases/{id} | Get a knowledge base |
PUT | /v1/knowledge-bases/{id} | Update name / description |
DELETE | /v1/knowledge-bases/{id} | Delete (purges all documents) |
Documents
| Method | Path | Purpose |
|---|
GET | /v1/knowledge-bases/{id}/documents | List documents |
POST | /v1/knowledge-bases/{id}/documents | Upload (multipart) |
DELETE | /v1/knowledge-bases/{id}/documents/{docId} | Remove a document |
POST | /v1/knowledge-bases/{id}/documents/{docId}/retry | Retry a failed indexing job |
processing → ready (or failed); poll GET /:id/documents or subscribe to the kb.document.ready webhook.
Search
| Method | Path | Purpose |
|---|
POST | /v1/knowledge-bases/{id}/search | Semantic search across documents |
curl -X POST https://orbit-api.devotel.io/api/v1/knowledge-bases/kb_abc/search \
-H "X-API-Key: dv_live_sk_your_key_here" \
-H "Content-Type: application/json" \
-d '{ "query": "How do refunds work for international orders?", "top_k": 4 }'
See also
