Docs

listFiles

List files for bot

GET/v1/files

Authorization

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

Header parameters

x-bot-idstringrequired
Bot id
x-integration-idstring
Integration id
x-integration-aliasstring
Integration alias
x-integration-namestring
Integration name
x-user-idstring
User Id
x-user-rolestring
User Role

Query parameters

nextTokenstring
Provide the meta.nextToken value provided in the last API response to retrieve the next page of results
sortFieldenum<string>
Sort results by this field
Available options:key,size,createdAt,updatedAt,status
sortDirectionenum<string>
Sort results in this direction
Available options:asc,desc
tagsany
Filter files by tags. Tags should be passed as a URL-encoded JSON object of key-value pairs that must be present in the tags of a file. An array of multiple string values for the same key are treated as an OR condition. To exclude a value, express it as an object with a nested not key with the string or string-array value(s) to exclude.
idsstring[]
Filter files by IDs.
indexedboolean
Filter files by indexing state

Response

application/json

Returns the list of files related to the bot.

The response is of type listFilesResponse · object.

filesobject[]required
metaobjectrequired