FilesVersion: v3

Get all files by knowledge base

GET/knowledge-bases/files

Lists files uploaded to a knowledge base, with optional pagination and name search. WHEN TO USE: use this when you need to see uploaded documents; use uploadFile to add a file; use getFileById for one file; use deleteFile to remove one. RETURNS: the file list for the knowledge base.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:knowledge-bases.readonly

Auth methods:OAuthPrivate Integration

Token type:Sub-Account Token

Request

Headers

Versionstringrequired

API Version

Available optionsv3

Example:v3

Query Parameters

knowledgeBaseIdstringrequired

knowledge base id

Example:ocQHyuzHvysMo5N5VsXc

limitnumber

Maximum number of files to return

Default:10

Example:10

lastFileIdstring

Last file id, used for pagination

Example:ocQHyuzHvysMo5N5VsXc

offsetnumber

Zero-based offset for search-mode pagination. Ignored when lastFileId is provided.

Default:0

Example:0

searchstring

Case-insensitive substring to match against the file name.

Example:invoice

Response

application/json

List of files by knowledge base

successbooleanrequired

success

Example:true

dataobjectrequired

data