updateFileMetadata

Update file metadata, without updating the file content.

PUT /v1/files/{id}

cURL

cURL

curl --request PUT \
  --url https://api.botpress.cloud/v1/files/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-bot-id: <x-bot-id>' \
  --data '
{
  "metadata": "<unknown>",
  "tags": {},
  "accessPolicies": [
    "integrations"
  ],
  "expiresAt": "2023-11-07T05:31:56Z"
}
'

200

{
  "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",
    "owner": {
      "type": "bot",
      "id": "<string>",
      "name": "<string>"
    },
    "failedStatusReason": "<string>",
    "expiresAt": "<string>",
    "indexingStack": "v1"
  }
}

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

Body

application/json

File metadata to update.

metadata · any

Custom metadata for the file expressed as an object of key-value pairs. Omit to keep existing metadata intact. Any existing metadata keys not included will be preserved. New keys will be added. To delete a metadata key, set its value to null.

tags · object

The file tags to update as an object of key-value pairs with string (text) values. Omit to keep existing tags intact. Any existing tags not included will be preserved. New tags will be added. To delete a tag, set its value to null.

Show child attributes

accessPolicies · enum<string>[]

New access policies to set for the file. Omit to keep existing policies intact.

Available options: integrations, public_content

expiresAt · string<date-time> | null

Expiry timestamp in ISO 8601 format with UTC timezone. After expiry, the File will be deleted. Must be in the future. Cannot be more than 90 days from now. The value up to minutes is considered. Seconds and milliseconds are ignored. Omit to keep the existing expiry intact. Set to null to remove the expiry.

Response

200

application/json

An object containing the updated file metadata.

file · object · required

Show child attributes