Sign in

v4

OpenAPI 3.1.02026-07-313621,3961.8 MB
Agents Platform

Get All Rag Chunks For A Document

Get all RAG chunks for a specific knowledge base document.

get/v1/convai/knowledge-base/{documentation_id}/chunks

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.

Query parameters

embedding_model'e5_mistral_7b_instruct' | 'multilingual_e5_large_instruct' required

The embedding model used to retrieve the chunk.

page_sizeinteger

How many documents to return at maximum. Can not exceed 100, defaults to 30.

How many documents to return at maximum. Can not exceed 100, defaults to 30.

cursorstring nullable

Used for fetching next page. Cursor is returned in the response.

Used for fetching next page. Cursor is returned in the response.

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.

Response

Successful Response

next_cursorstring nullable