getFile

Get file

GET/v1/files/{id}

Authorization

AuthorizationBearer

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

Header parameters

x-bot-idstring

Bot id

x-integration-id?string

Integration id

x-integration-alias?string

Integration alias

x-integration-name?string

Integration name

x-user-id?string

User Id

x-user-role?string

User Role

Path parameters

idstring

File ID or Key

Response

An object containing the file metadata and URL

fileobject

Request

curl --request GET \ \
  --url https://api.botpress.cloud/v1/files/{id} \
  --header 'x-bot-id: <x-bot-id>' \
  --header 'Authorization: Bearer <token>'

Response

{
  "file": {
    "id": "string",
    "botId": "string",
    "key": "string",
    "url": "string",
    "size": 0,
    "contentType": "string",
    "tags": {
      "key": "string"
    },
    "metadata": {
      "key": null
    },
    "createdAt": "string",
    "updatedAt": "string",
    "accessPolicies": [
      "integrations"
    ],
    "index": true,
    "status": "upload_pending",
    "failedStatusReason": "string",
    "expiresAt": "string",
    "owner": {
      "type": "bot",
      "id": "string",
      "name": "string",
      "alias": "string"
    },
    "indexingStack": "v1"
  }
}