GET
/
v1
/
files
cURL
curl --request GET \
  --url https://api.botpress.cloud/v1/files \
  --header 'Authorization: Bearer <token>' \
  --header 'x-bot-id: <api-key>'
{
  "files": [
    {
      "id": "<string>",
      "botId": "<string>",
      "key": "<string>",
      "url": "<string>",
      "size": 123,
      "contentType": "<string>",
      "tags": {},
      "metadata": {},
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "accessPolicies": [
        "integrations"
      ],
      "index": true,
      "status": "upload_pending",
      "failedStatusReason": "<string>",
      "expiresAt": "<string>",
      "owner": {
        "type": "bot",
        "id": "<string>",
        "name": "<string>"
      }
    }
  ],
  "meta": {
    "nextToken": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

​
x-bot-id
string
header
required

Your bot ID.

Query Parameters

​
nextToken
string

Provide the meta.nextToken value provided in the last API response to retrieve the next page of results

​
sortField
enum<string>

Sort results by this field

Available options:
key,
size,
createdAt,
updatedAt,
status
​
sortDirection
enum<string>

Sort results in this direction

Available options:
asc,
desc
​
tags
any

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.

​
ids
string[]

Filter files by IDs.

Maximum length: 50

Response

Returns the list of files related to the bot.

​
files
object[]
required
​
meta
object
required