Chat API
- Introduction
- Endpoints
Admin API
- Getting started
- Concepts
- Endpoints
Files API
Tables API
Runtime API
- Getting Started
- Concepts
- Endpoints
listTables
Retrieves a list of all tables associated with your bot.
curl --request GET \
--url https://api.botpress.cloud/v1/tables{
"tables": [
{
"id": "<string>",
"name": "<string>",
"factor": 1,
"frozen": true,
"schema": {
"$schema": "<string>",
"properties": {},
"additionalProperties": true,
"required": [
"<string>"
],
"type": "object"
},
"tags": {},
"isComputeEnabled": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}Query Parameters
Response
Unique identifier for the table
Required. This name is used to identify your table.
1List of keys/columns in the table.
string, number, boolean, object, array, null date-time String properties must match this pattern
String properties must be one of these values
Defines the shape of items in an array
Additional properties can be provided, but they will be ignored if no column matches.
object Array of required properties.
The 'factor' multiplies the row's data storage limit by 4KB and its quota count, but can only be set at table creation and not modified later. For instance, a factor of 2 increases storage to 8KB but counts as 2 rows in your quota. The default factor is 1.
1 <= x <= 30A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.
Optional tags to help organize your tables. These should be passed here as an object representing key/value pairs.
Indicates if the table is enabled for computation.
Timestamp of table creation.
Timestamp of the last table update.
Was this page helpful?
curl --request GET \
--url https://api.botpress.cloud/v1/tables{
"tables": [
{
"id": "<string>",
"name": "<string>",
"factor": 1,
"frozen": true,
"schema": {
"$schema": "<string>",
"properties": {},
"additionalProperties": true,
"required": [
"<string>"
],
"type": "object"
},
"tags": {},
"isComputeEnabled": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}