CONVERSATIONAL AIKnowledge Base

List knowledge base documents

Get a list of available knowledge base documents

Headers

xi-api-keystringRequired

Query parameters

cursorstringOptional

Used for fetching next page. Cursor is returned in the response.

page_sizeintegerOptional>=1<=100Defaults to 30

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

searchstringOptional

If specified, the endpoint returns only such knowledge base documents whose names start with this string.

show_only_owned_documentsbooleanOptionalDefaults to false

If set to true, the endpoint will return only documents owned by you (and not shared from somebody else).

use_typesensebooleanOptionalDefaults to false

If set to true, the endpoint will use typesense DB to search for the documents).

Response

Successful Response

documentslist of objects
has_moreboolean
next_cursorstringOptional

Errors