Agents Platform

Get All Rag Chunks For A Document

Changed on

Get all RAG chunks for a specific knowledge base document.

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

Request

  • Base URL
    https://api.elevenlabs.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.elevenlabs.io/v1/convai/knowledge-base/{documentation_id}/chunks
  • Auth
    none declared

Path parameters

documentation_idstring required

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

Example:21m00Tcm4TlvDq8ikWAM

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.

cursorstring nullable

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.

Response

Successful Response

next_cursorstring nullable

Changes