Sign in

v5

latestOpenAPI 3.1.02026-08-043621,4011.8 MB
Agents Platform

Compute Rag Index.

In case the document is not RAG indexed, it triggers rag indexing task, otherwise it just returns the current status.

post/v1/convai/knowledge-base/{documentation_id}/rag-index

Path parameters

documentation_idstring required

The id of a document from the knowledge base. This is returned on document addition.

Example:21m00Tcm4TlvDq8ikWAM

The id of a document from the knowledge base. This is returned on document addition.

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

model'e5_mistral_7b_instruct' | 'multilingual_e5_large_instruct' required

Response

Successful Response

idstring required
model'e5_mistral_7b_instruct' | 'multilingual_e5_large_instruct' required
status'new' | 'created' | 'processing' | 'failed' | 'succeeded' | 'rag_limit_exceeded' | 'document_too_small' | 'cannot_index_folder' required
progress_percentagenumber required