Docs

getOrCreateTable

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

POST/v1/tables/{table}

Authorization

AuthorizationBearerrequired
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Header parameters

x-bot-idstringrequired
Bot id
x-integration-idstring
Integration id
x-integration-aliasstring
Integration alias
x-integration-namestring
Integration name
x-user-idstring
User Id
x-user-rolestring
User Role

Path parameters

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

Request body

Schema defining the structure of the table

factornumberdefault: 1
The 'factor' multiplies the row's data storage limit by 4KB and its quota count. It can only be increased (not decreased) after table creation via updateTable. For instance, a factor of 2 increases storage to 8KB but counts as 2 rows in your quota. The default factor is 1.(>= 1, <= 30)
frozenboolean
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.
keyColumnstring | null
Designate a column as the primary unique identifier for this table. When set, a unique index is automatically created on this column, enabling significantly faster upsert operations. All values in this column must be unique across the table. When set to null, the key index is removed.
schemaobjectrequired
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.
tagsobject
Optional tags to help organize your tables. These should be passed here as an object representing key/value pairs.
isComputeEnabledboolean
Indicates if the table is enabled for computation.

Response

The retrieved or created table object.

tableobjectrequired
createdbooleanrequired
Flag indicating if the table was newly created.
rowsnumberrequired
The total number of rows present in the table.
stalenumberrequired
The number of stale rows that are waiting to be processed
indexingnumberrequired
The number of rows that are waiting to be indexed (for search)