Agents Platform

Search Knowledge Base Content

Fuzzy text search over knowledge base document content

get/v1/convai/knowledge-base/search

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

Changed in 1 of the 27 revisions of this API.3

Jul 26, 2026494d96419d153See the full diff
- ○
  added the optional property results/items/document/oneOf[subschema #2: GetKnowledgeBaseSummaryFileResponseModel]/auto_sync_info to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property results/items/document/oneOf[subschema #2: GetKnowledgeBaseSummaryFileResponseModel]/refresh_status to the response with the 200 status
  response-optional-property-added
- ○
  added the required property results/items/document/oneOf[subschema #4: GetKnowledgeBaseSummaryFolderResponseModel]/document_count to the response with the 200 status
  response-required-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history