Sign in

v4

OpenAPI 3.1.02026-07-313621,3961.8 MB
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

The search query text

page_sizeinteger

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

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.

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.

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.

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"
        }
      }
    }
  ]
}