POST
/
v1
/
files
/
{idOrKey}
/
{destinationKey}
cURL
curl --request POST \
  --url https://api.botpress.cloud/v1/files/{idOrKey}/{destinationKey} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-bot-id: <api-key>' \
  --data '{
  "overwrite": true
}'
{
  "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.

Headers

​
x-destination-bot-id
string

The bot ID to copy the file to. You must have permission to create files in the destination bot. If the destination bot ID is omitted, the file will be copied to the same bot the source file belongs to.

Path Parameters

​
idOrKey
string
required

File ID or Key

​
destinationKey
string
required

The new key of the file. The file key must not be in use already in the destination bot.

Body

application/json

Additional options for file copying.

​
overwrite
boolean

Set to true to overwrite the file if it already exists; otherwise, an error will be returned.

When this endpoint is called using bot authentication, the existing file must have been originally created by the same bot making the file copy request in order to overwrite it.

Response

An object containing the file metadata and URL

​
file
object
required