AI Knowledge Base

RAG (Retrieval-Augmented Generation) document index management endpoints

📄️ Get document index

Returns the knowledge base document index for the given project and index types. Each index entry contains a list of documents with their URL, update time, number of entities (products or categories) it is assigned to, and optionally the assigned scope IDs.

📄️ Get document details

Returns the full details of a single document across the requested index types, including extracted content and all metadata.

📄️ Index documents

Crawls and indexes one or more documents into the specified knowledge base index type. The documents are fetched from their URLs, chunked, and stored for use in retrieval-augmented generation.

📄️ Delete documents from index

Removes one or more documents from the specified knowledge base index type. The documents are identified by their URLs.

📄️ Index documents (content payload)

Indexes text content supplied directly in the request body, rather than crawling documents from URLs. The texts are chunked and stored for use in retrieval-augmented generation.

📄️ Delete all documents from index

Removes **all** documents from the specified knowledge base index type for the given project.

📄️ Update documents

Re-crawls and re-indexes a set of documents that are already present in the specified knowledge base index type. Existing scope assignments for the documents are preserved.

📄️ Update all documents

Re-crawls and re-indexes **all** documents currently present in the specified knowledge base index type for the given project. Scope assignments are preserved.