Agents Platform

Compute Rag Index.

Changed on

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

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}/rag-index
  • 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

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.

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

Changes

  • deb5e58ddddfRevision changes
    • warning

      added the new new enum value to the response property for the response status

    • info

      the request property default value e5_mistral_7b_instruct was added

    • info

      the response's property default value e5_mistral_7b_instruct was added for the status

  • 5b595807512cRevision changes
    • warning

      added the new cannot_index_folder enum value to the response property for the response status

    • warning

      added the new document_too_small enum value to the response property for the response status

    • warning

      added the new rag_limit_exceeded enum value to the response property for the response status

    • info

      api operation id Compute_RAG_index__v1_convai_knowledge_base__documentation_id__rag_index_post removed and replaced with rag_index_status

    • info

      api tag Agents Platform added

    • info

      api tag Conversational AI removed

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status