Agents Platform

Search Knowledge Base Content

Changed on

Fuzzy text search over knowledge base document content

get/v1/convai/knowledge-base/search

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/search
  • Auth
    none declared

Query parameters

querystring required

The search query text

page_sizeinteger

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

typesKnowledgeBaseDocumentType[] nullable

If present, the endpoint will return only documents of the given types.

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

Example response

{
  "results": [
    {
      "document": {
        "access_info": {
          "access_source": "creator",
          "creator_email": "john.doe@example.com",
          "creator_name": "John Doe",
          "is_creator": true,
          "role": "admin"
        }
      }
    }
  ]
}

Changes

  • 22b5bd67b6c6Revision changes
    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ////// from the response with the status

  • 0c930e56e185Revision changes
    • info

      response property results/items/document/oneOf[subschema #1: GetKnowledgeBaseSummaryURLResponseModel]/auto_sync_info/anyOf[subschema #1: AutoSyncInfo]/auto_discover deprecated

    • info

      response property results/items/document/oneOf[subschema #2: GetKnowledgeBaseSummaryFileResponseModel]/auto_sync_info/anyOf[subschema #1: AutoSyncInfo]/auto_discover deprecated

    • info

      response property results/items/document/oneOf[subschema #4: GetKnowledgeBaseSummaryFolderResponseModel]/auto_sync_info/anyOf[subschema #1: AutoSyncInfo]/auto_discover deprecated