RAG

Create a RAG collection

Requires tools:exec; a tools:read bearer lists collections but cannot create one.

post/v1/rag/collections

Request

  • Base URL: http://localhost:9998
  • URL: http://localhost:9998/v1/rag/collections
  • Auth: HTTP bearer

Request body

namestring required
folderPathstring required

Absolute path to an existing folder to index. A collection indexes the folder's whole subtree, so a folder that holds or sits inside a credential store (such as ~/.ssh, the keychains, or ToolPiper's vault and clipboard history) is refused with a 400 that says so; ~, ~/Library, ToolPiper's support directory and / are refused for that reason.

embeddingModelStemstring required

Model stem to use for embeddings (from /v1/models)

chunkSizeinteger
chunkOverlapinteger

Response

Created collection

idstring required
namestring required
folderPathstring required
embeddingModelStemstring required
chunkSizeinteger required
chunkOverlapinteger required
status'empty' | 'indexed' | 'stale' | 'error' required
lastIndexedAtstring date-time nullable
documentCountinteger required
chunkCountinteger required
dimensionsinteger required
errorMessagestring nullable
projectIdstring

The project whose knowledge this collection is; it indexes that project's materials and is changed through the project. Absent for a collection a person made.

Changes

No recorded changes to this operation across all 1 revision of this API.