Get Or Create Table

post https://api.botpress.cloud/v1/tables/{table}

Retrieves information about a specific table if it exists; otherwise, creates a new table based on the provided schema.

Path Params

table

string

required

The table's name or unique identifier for targeting specific table operations.

Body Params

Schema defining the structure of the table

factor

number

1 to 30

Defaults to 1

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.

frozen

boolean

A 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.

schema

object

required

Provide an object or a JSON schema to define the columns of the table. A maximum of 20 keys in the object/schema is allowed.

tags

object

Optional tags to help organize your tables. These should be passed here as an object representing key/value pairs.

isComputeEnabled

boolean

Indicates if the table is enabled for computation.

Headers

x-bot-id

string

required

Bot ID

x-workspace-id

string

required

Workspace ID

Responses

Language

Credentials

Bearer

PAT


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.botpress.cloud/v1/tables/table \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

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

application/json

200The retrieved or created table object.

defaultThe retrieved or created table object.