upsertFile

PUT

files

curl --request PUT \
  --url https://api.botpress.cloud/v1/files \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "<string>",
  "tags": {},
  "size": 123,
  "index": false,
  "indexing": {
    "configuration": {
      "parsing": {
        "minimumParagraphLength": 1025,
        "smartCleanup": true
      },
      "chunking": {
        "maximumChunkLength": 2550,
        "embeddedContextLevels": 1,
        "embedBreadcrumb": true
      },
      "summarization": {
        "enable": false,
        "modelType": "balanced",
        "minimumInputLength": 5500,
        "outputTokenLimit": 5500,
        "generateMasterSummary": true
      },
      "vision": {
        "transcribePages": "<any>",
        "indexPages": "<any>"
      }
    }
  },
  "accessPolicies": [
    "public_content"
  ],
  "contentType": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "publicContentImmediatelyAccessible": true,
  "metadata": "<any>"
}'

{
  "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>",
    "uploadUrl": "<string>"
  }
}

Body

application/json

Properties of the file to create or update.

key

string

required

Unique key for the file. Must be unique across the bot (and the integration, when applicable).

size

number

required

File size in bytes. This will count against your File Storage quota. If the index parameter is set to true, this will also count against your Vector DB Storage quota.

Response

200

application/json

The created or updated file

file

object

required

file.id

string

required

File ID

file.botId

string

required

The ID of the bot the file belongs to

file.key

string

required

Unique key for the file. Must be unique across the bot (and the integration, when applicable).

file.url

string

required

URL to retrieve the file content. This URL will be ready to use once the file is uploaded.

If the file has a public_content policy, this will contain the permanent public URL to retrieve the file, otherwise this will contain a temporary pre-signed URL to download the file which should be used shortly after retrieving and should not be stored long-term as the URL will expire after a short timeframe.

file.size

number | null

required

File size in bytes. Non-null if file upload status is "COMPLETE".

file.contentType

string

required

MIME type of the file's content

file.tags

object

required

The tags of the file as an object of key/value pairs

file.metadata

object

required

Metadata of the file as an object of key/value pairs. The values can be of any type.

file.createdAt

string

required

File creation timestamp in ISO 8601 format

file.updatedAt

string

required

File last update timestamp in ISO 8601 format

file.accessPolicies

enum<string>[]

required

Access policies configured for the file.

Available options:

integrations,

public_content

file.index

boolean

required

Whether the file was requested to be indexed for search or not.

file.status

enum<string>

required

Status of the file. If the status is upload_pending, the file content has not been uploaded yet. The status will be set to upload_completed once the file content has been uploaded successfully.

If the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to upload_failed and the reason for the failure will be available in the failedStatusReason field of the file.

However, if the file has been uploaded and the index attribute was set to true on the file, the status will immediately transition to the indexing_pending status (the upload_completed status step will be skipped).

Once the indexing is completed and the file is ready to be used for searching its status will be set to indexing_completed. If the indexing failed the status will be set to indexing_failed and the reason for the failure will be available in the failedStatusReason field.

Available options:

upload_pending,

upload_failed,

upload_completed,

indexing_pending,

indexing_failed,

indexing_completed

file.uploadUrl

string

required

URL to upload the file content. File content needs to be sent to this URL via a PUT request.

file.failedStatusReason

string

If the file status is upload_failed or indexing_failed this will contain the reason of the failure.

file.expiresAt

string

File expiry timestamp in ISO 8601 format

Was this page helpful?

Suggest edits Raise issue

Manage files listFiles

curl --request PUT \
  --url https://api.botpress.cloud/v1/files \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "<string>",
  "tags": {},
  "size": 123,
  "index": false,
  "indexing": {
    "configuration": {
      "parsing": {
        "minimumParagraphLength": 1025,
        "smartCleanup": true
      },
      "chunking": {
        "maximumChunkLength": 2550,
        "embeddedContextLevels": 1,
        "embedBreadcrumb": true
      },
      "summarization": {
        "enable": false,
        "modelType": "balanced",
        "minimumInputLength": 5500,
        "outputTokenLimit": 5500,
        "generateMasterSummary": true
      },
      "vision": {
        "transcribePages": "<any>",
        "indexPages": "<any>"
      }
    }
  },
  "accessPolicies": [
    "public_content"
  ],
  "contentType": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "publicContentImmediatelyAccessible": true,
  "metadata": "<any>"
}'

{
  "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>",
    "uploadUrl": "<string>"
  }
}

Chat API

Admin API

Files API

Tables API

Runtime API

Body

Response