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: <x-bot-id>'
{
  "file": {
    "id": "<string>",
    "botId": "<string>",
    "key": "<string>",
    "url": "<string>",
    "size": 123,
    "contentType": "<string>",
    "tags": {},
    "metadata": {},
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "accessPolicies": [],
    "index": true,
    "owner": {
      "id": "<string>",
      "name": "<string>",
      "alias": "<string>"
    },
    "failedStatusReason": "<string>",
    "expiresAt": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://botpress-add-desk-to-botpress-docs.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-bot-id
string
required

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

​
id
string
required

File ID or Key

Response

An object containing the file metadata and URL

​
file
object
required
Last modified on May 27, 2026