List Files

get https://api.botpress.cloud/v1/files

List files for bot

Log in to see full request history

Responses

Response body

object

files

array of objects

required

files*

object

id

string

required

File ID

botId

string

required

The ID of the bot the file belongs to

key

string

required

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

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.

size

number | null

required

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

contentType

string

required

MIME type of the file's content

tags

object

required

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

Has additional fields

metadata

object

required

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

Has additional fields

createdAt

string

required

File creation timestamp in ISO 8601 format

updatedAt

string

required

File last update timestamp in ISO 8601 format

accessPolicies

array of strings

required

Access policies configured for the file.

accessPolicies*

index

boolean

required

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

status

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.

upload_pending upload_failed upload_completed indexing_pending indexing_failed indexing_completed

failedStatusReason

string

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

expiresAt

string

File expiry timestamp in ISO 8601 format

meta

object

required

nextToken

string

The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint.

Response body

object

files

array of objects

required

files*

object

id

string

required

File ID

botId

string

required

The ID of the bot the file belongs to

key

string

required

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

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.

size

number | null

required

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

contentType

string

required

MIME type of the file's content

tags

object

required

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

Has additional fields

metadata

object

required

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

Has additional fields

createdAt

string

required

File creation timestamp in ISO 8601 format

updatedAt

string

required

File last update timestamp in ISO 8601 format

accessPolicies

array of strings

required

Access policies configured for the file.

accessPolicies*

index

boolean

required

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

status

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.

upload_pending upload_failed upload_completed indexing_pending indexing_failed indexing_completed

failedStatusReason

string

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

expiresAt

string

File expiry timestamp in ISO 8601 format

meta

object

required

nextToken

string

The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint.

Language

Credentials

Bearer

PAT


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.botpress.cloud/v1/files \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json