Agents Platform

Get Documentation Chunk From Knowledge Base

Changed on

Get details about a specific documentation part used by RAG.

get/v1/convai/knowledge-base/{documentation_id}/chunk/{chunk_id}

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}/chunk/{chunk_id}
  • 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
chunk_idstring required

The id of a document RAG chunk from the knowledge base.

Query parameters

embedding_model'e5_mistral_7b_instruct' | 'multilingual_e5_large_instruct'

The embedding model used to retrieve the chunk.

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
namestring required
contentstring required

Changes

  • deb5e58ddddfRevision changes
    • info

      added the new optional query request parameter embedding_model

  • 5b595807512cRevision changes
    • info

      api operation id Get_documentation_chunk_from_knowledge_base_v1_convai_knowledge_base__documentation_id__chunk__chunk_id__get removed and replaced with get_documentation_chunk_from_knowledge_base

    • info

      api tag Agents Platform added

    • info

      api tag Conversational AI removed