Agents Platform

Get Chunking Override

Changed on

Get the stored and effective RAG chunking overrides for a document or folder.

get/v1/convai/knowledge-base/{documentation_id}/chunking-override

Request

Path parameters

documentation_idstring required

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

Example:21m00Tcm4TlvDq8ikWAM

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

idstring required

ID of the document or folder whose chunking settings were read.

Example response

{
  "chunking_override": {
    "custom_separators": [
      "\n### "
    ],
    "max_chunk_size": 800,
    "overlap_percentage": 15
  },
  "effective_chunking_override": {
    "custom_separators": [
      "\n### "
    ],
    "max_chunk_size": 800,
    "overlap_percentage": 15
  },
  "id": "21m00Tcm4TlvDq8ikWAM",
  "inherited_chunking_override": {
    "custom_separators": [
      "\n## "
    ],
    "max_chunk_size": 500,
    "overlap_percentage": 10
  }
}

Changes