API Reference

Knowledge Base

21 endpoints under /api/knowledge-base

get/api/knowledge-base
🔑 API keyKNOWLEDGE_BASE_READ

List Knowledge Bases

Get knowledge bases with pagination, sorting, and filtering.

Query parameters

FieldTypeRequiredDescription
pageinteger—Page number
page_sizeinteger—Items per page
sort_bystring | null—Field to sort by
sort_orderstring—Sort order
searchstring | null—Search in name or description
namestring | null—Filter by exact name
descriptionstring | null—Filter by description
created_afterstring (date-time) | null—Created after date
created_beforestring (date-time) | null—Created before date

Responses

  • 200Successful ResponsePaginatedResponse_KnowledgeBaseDTO_
post/api/knowledge-base
🔑 API keyKNOWLEDGE_BASE_WRITE

Create Knowledge Base

Create a new knowledge base container.

Request body

FieldTypeRequiredDescription
descriptionstring | null—
editGroupIdsinteger[] | null—
namestringyes
useGroupIdsinteger[] | null—

Responses

  • 200Successful ResponseKnowledgeBaseDTO
delete/api/knowledge-base/{knowledge_base_id}
🔑 API keyKNOWLEDGE_BASE_WRITE

Delete Knowledge Base

Delete a knowledge base container and all its entries.

Path parameters

FieldTypeRequiredDescription
knowledge_base_idintegeryes

Responses

  • 200Successful Responseobject
get/api/knowledge-base/{knowledge_base_id}
🔑 API keyKNOWLEDGE_BASE_READ

Get Knowledge Base

Get a knowledge base container by ID.

Path parameters

FieldTypeRequiredDescription
knowledge_base_idintegeryes

Responses

  • 200Successful ResponseKnowledgeBaseDTO
put/api/knowledge-base/{knowledge_base_id}
🔑 API keyKNOWLEDGE_BASE_WRITE

Update Knowledge Base

Update a knowledge base container.

Path parameters

FieldTypeRequiredDescription
knowledge_base_idintegeryes

Request body

FieldTypeRequiredDescription
descriptionstring | null—
editGroupIdsinteger[] | null—
namestring | null—
useGroupIdsinteger[] | null—

Responses

  • 200Successful ResponseKnowledgeBaseDTO
get/api/knowledge-base/{knowledge_base_id}/entries
🔑 API keyKNOWLEDGE_BASE_READ

List Knowledge Base Entries

Get all entries for a specific knowledge base.

Path parameters

FieldTypeRequiredDescription
knowledge_base_idintegeryes

Responses

  • 200Successful ResponseKnowledgeBaseEntryDTO[]
delete/api/knowledge-base/{knowledge_base_id}/entries/{entry_id}
🔑 API keyKNOWLEDGE_BASE_WRITE

Delete Knowledge Base Entry

Delete a knowledge base entry and its embeddings.

Path parameters

FieldTypeRequiredDescription
knowledge_base_idintegeryes
entry_idintegeryes

Responses

  • 200Successful Responseobject
get/api/knowledge-base/{knowledge_base_id}/entries/{entry_id}
🔑 API keyKNOWLEDGE_BASE_READ

Get Knowledge Base Entry

Get a single knowledge base entry by ID.

Path parameters

FieldTypeRequiredDescription
knowledge_base_idintegeryes
entry_idintegeryes

Responses

  • 200Successful ResponseKnowledgeBaseEntryDTO
patch/api/knowledge-base/{knowledge_base_id}/entries/{entry_id}
🔑 API keyKNOWLEDGE_BASE_WRITE

Update Knowledge Base Entry

Update a knowledge base entry. Supports partial updates of: - `display_name` and `metadata` (FILE entries only — same constraints as before) - `enabled` (any entry type — toggles whether the entry is included in KB retrieval)

Path parameters

FieldTypeRequiredDescription
knowledge_base_idintegeryes
entry_idintegeryes

Request body

FieldTypeRequiredDescription
display_namestring | null—
enabledboolean | null—
metadataobject | null—

Responses

  • 200Successful ResponseKnowledgeBaseEntryDTO
get/api/knowledge-base/{knowledge_base_id}/entries/{entry_id}/chunks
🔑 API keyKNOWLEDGE_BASE_READ

List Entry Chunks

List stored chunks for an uploaded file entry.

Path parameters

FieldTypeRequiredDescription
knowledge_base_idintegeryes
entry_idintegeryes

Responses

  • 200Successful ResponseKnowledgeBaseChunkDTO[]
delete/api/knowledge-base/{knowledge_base_id}/entries/{entry_id}/chunks/{chunk_id}
🔑 API keyKNOWLEDGE_BASE_WRITE

Delete Entry Chunk

Delete one stored file chunk and refresh the entry summary.

Path parameters

FieldTypeRequiredDescription
knowledge_base_idintegeryes
entry_idintegeryes
chunk_idintegeryes

Responses

  • 200Successful ResponseKnowledgeBaseEntryDTO
get/api/knowledge-base/{knowledge_base_id}/entries/{entry_id}/chunks/{chunk_id}
🔑 API keyKNOWLEDGE_BASE_READ

Get Entry Chunk

Return the full text for one stored file chunk.

Path parameters

FieldTypeRequiredDescription
knowledge_base_idintegeryes
entry_idintegeryes
chunk_idintegeryes

Responses

  • 200Successful ResponseKnowledgeBaseChunkTextDTO
get/api/knowledge-base/{knowledge_base_id}/entries/{entry_id}/logs
🔑 API keyKNOWLEDGE_BASE_READ

List Crawl Logs

Return the time-ordered log lines emitted during this entry's crawl.

Path parameters

FieldTypeRequiredDescription
knowledge_base_idintegeryes
entry_idintegeryes

Responses

  • 200Successful ResponseCrawlLogEntryDTO[]
get/api/knowledge-base/{knowledge_base_id}/entries/{entry_id}/pages
🔑 API keyKNOWLEDGE_BASE_READ

List Crawled Pages

List the per-URL records of the most recent crawl for a website entry. Markdown is excluded from this payload — fetch it per-page from the `/markdown` endpoint when needed.

Path parameters

FieldTypeRequiredDescription
knowledge_base_idintegeryes
entry_idintegeryes

Responses

  • 200Successful ResponseCrawledPageDTO[]
delete/api/knowledge-base/{knowledge_base_id}/entries/{entry_id}/pages/{page_id}
🔑 API keyKNOWLEDGE_BASE_WRITE

Delete Crawled Page

Drop one captured page from the entry. Removes the per-URL `crawled_pages` row AND deletes the embeddings tied to that URL in the vector store, so the page stops being retrieved by search. The entry's denormalized summary (page count, total bytes) is recomputed from what's left.

Path parameters

FieldTypeRequiredDescription
knowledge_base_idintegeryes
entry_idintegeryes
page_idintegeryes

Responses

  • 200Successful ResponseKnowledgeBaseEntryDTO
get/api/knowledge-base/{knowledge_base_id}/entries/{entry_id}/pages/{page_id}/markdown
🔑 API keyKNOWLEDGE_BASE_READ

Get Crawled Page Markdown

Return the extracted markdown for one crawled page.

Path parameters

FieldTypeRequiredDescription
knowledge_base_idintegeryes
entry_idintegeryes
page_idintegeryes

Responses

  • 200Successful ResponseCrawledPageMarkdownDTO
post/api/knowledge-base/{knowledge_base_id}/entries/{entry_id}/recrawl
🔑 API keyKNOWLEDGE_BASE_WRITE

Recrawl Entry

Re-run the crawl for an existing website entry. Returns immediately with the entry marked as `in_progress`. The crawl and persistence run as a background task. Prior `crawled_pages` rows for this entry are replaced atomically when the new crawl completes.

Path parameters

FieldTypeRequiredDescription
knowledge_base_idintegeryes
entry_idintegeryes

Responses

  • 200Successful ResponseKnowledgeBaseEntryDTO
post/api/knowledge-base/{knowledge_base_id}/search
🔑 API keyKNOWLEDGE_BASE_READ

Search Knowledge Base

Search a knowledge base using semantic vector search.

Path parameters

FieldTypeRequiredDescription
knowledge_base_idintegeryes

Request body

FieldTypeRequiredDescription
limitinteger—
querystringyes

Responses

  • 200Successful ResponseSearchKnowledgeBaseResponse
post/api/knowledge-base/{knowledge_base_id}/upload
🔑 API keyKNOWLEDGE_BASE_WRITE

Upload File

Upload a file to a knowledge base. Creates the entry immediately (status `in_progress`) and defers extraction + embedding to the worker consumer (`ingest_file` job). Clients poll `last_crawl_status`.

Path parameters

FieldTypeRequiredDescription
knowledge_base_idintegeryes

Request body

FieldTypeRequiredDescription
filestringyes

Responses

  • 200Successful ResponseKnowledgeBaseEntryDTO
post/api/knowledge-base/{knowledge_base_id}/upload-website
🔑 API keyKNOWLEDGE_BASE_WRITE

Upload Website

Ingest a website into a knowledge base. Returns immediately with the entry marked as `in_progress`. The crawl and embedding work runs as a background task. Clients should poll the entry's `last_crawl_status` (or refetch after a short delay) to observe completion.

Path parameters

FieldTypeRequiredDescription
knowledge_base_idintegeryes

Request body

FieldTypeRequiredDescription
urlstringyes

Responses

  • 200Successful ResponseKnowledgeBaseEntryDTO
patch/api/knowledge-base/{knowledge_base_id}/variables
🔑 API keyKNOWLEDGE_BASE_WRITE

Update Knowledge Base Variables

Replace the custom variable schema for a knowledge base.

Path parameters

FieldTypeRequiredDescription
knowledge_base_idintegeryes

Request body

FieldTypeRequiredDescription
variablesKnowledgeBaseVariableDTO[]—

Responses

  • 200Successful ResponseKnowledgeBaseDTO