Skip to main content
GET
/
v1
/
files
/
{id}
cURL
curl --request GET \
  --url https://api.botpress.cloud/v1/files/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-bot-id: <api-key>'
{
  "file": {
    "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>"
    }
  }
}

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.

Path Parameters

​
id
string
required

File ID or Key

Response

An object containing the file metadata and URL

​
file
object
required