API Documentation

Authentication

All API requests require authentication using a Bearer token in the Authorization header:

Authorization: Bearer YOUR_API_TOKEN

Collections API

List Collections

GET /api/collections

Create Collection

POST /api/collections

{
  "name": "my-collection",
  "description": "Collection description"
}

Get Collection

GET /api/collections/{id}

Delete Collection

DELETE /api/collections/{id}

Documents API

Upload Document

POST /api/collections/{collectionId}/documents

Form data with file upload

List Documents

GET /api/collections/{collectionId}/documents

Delete Document

DELETE /api/documents/{id}

Chunks API

List Chunks

GET /api/documents/{documentId}/chunks

Update Chunk

PUT /api/chunks/{id}

{
  "content": "Updated chunk content"
}

Retrieval API

Retrieve Chunks

POST /api/retrieve

{
  "query": "search query",
  "collectionId": "collection-id",
  "limit": 5,
  "metadata": {
    "category": "example"
  }
}

Settings API

Get Settings

GET /api/settings

Update Settings

POST /api/settings

{
  "openai": {
    "apiKey": "sk-...",
    "model": "text-embedding-3-large"
  },
  "chroma": {
    "url": "http://chroma:8000",
    "topK": 4
  }
}

API Testing

Test API endpoints directly from this page:

Endpoints