Update File Metadata

Request Body

application/json

File metadata to update.

TypeScript Definitions

Use the request body type in TypeScript.

metadata?unknown

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?

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.

accessPolicies?array<>

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

expiresAt?|

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.

Formatdate-time

Response Body

`application/json`

curl -X PUT "https://example.com/v1/files/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "file": {    "id": "string",    "botId": "string",    "key": "string",    "url": "string",    "size": 0,    "contentType": "string",    "tags": {      "property1": "string",      "property2": "string"    },    "metadata": {      "property1": null,      "property2": 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"  }}

{  "file": {    "id": "string",    "botId": "string",    "key": "string",    "url": "string",    "size": 0,    "contentType": "string",    "tags": {      "property1": "string",      "property2": "string"    },    "metadata": {      "property1": null,      "property2": 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"  }}

Path Parameters

Request Body

Response Body

200application/json

defaultapplication/json

`application/json`

`application/json`