Agents platformKnowledge BaseDocuments

List knowledge base documents

Get a list of available knowledge base documents

Headers

xi-api-keystringRequired

Query parameters

page_sizeintegerOptional1-100Defaults to 30
How many documents to return at maximum. Can not exceed 100, defaults to 30.
searchstring or nullOptional
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).

typeslist of enums or nullOptional
If present, the endpoint will return only documents of the given types.
Allowed values:
parent_folder_idstring or nullOptional
If set, the endpoint will return only documents that are direct children of the given folder.
ancestor_folder_idstring or nullOptional
If set, the endpoint will return only documents that are descendants of the given folder.
folders_firstbooleanOptionalDefaults to false
Whether folders should be returned first in the list of documents.
sort_directionenumOptional
The direction to sort the results
Allowed values:
sort_byenum or nullOptional
The field to sort the results by
Allowed values:
use_typesensebooleanOptionalDefaults to falseDeprecated

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

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

Response

Successful Response
documentslist of objects
has_moreboolean
next_cursorstring or null

Errors