Skip to main content
POST
/
data
/
projects
/
{projectId}
/
bitable
/
{tableName}
Create BI Table
curl --request POST \
  --url https://partner.peaka.studio/api/v1/data/projects/{projectId}/bitable/{tableName} \
  --header 'Authorization: Bearer <token>'
{
  "catalogId": "1",
  "catalogName": "peaka",
  "schemaName": "bitable",
  "tableName": "testtable",
  "isCacheable": false,
  "isDynamicTable": false,
  "isCached": false
}

Authorizations

​
Authorization
string
header
required

Use the Authorization header with the value 'Bearer ' to authenticate. Partner API Keys have full access; Project API Keys are limited to their project scope. Learn more: https://docs.peaka.com/api-reference/authentication

Path Parameters

​
projectId
string
required

ID of the Project

​
tableName
string
required

Name of the BI table to create

Response

200 - */*

Table created successfully

Represents a table in a schema.

​
catalogId
string

The ID of the catalog that the table belongs to.

​
catalogName
string

The name of the catalog that the table belongs to.

​
schemaName
string

The name of the schema that the table belongs to.

​
tableName
string

The name of the table.

​
isCacheable
boolean

Indicates whether the table is cacheable or not.

​
isDynamicTable
boolean

Indicates whether the table has required query parameter columns or not. A query parameter column is prefixed with "q" e.g. "_q_date". These columns are used to filter the data in the table.

​
isCached
boolean

Indicates whether the table is cached or not. It is not the status of caching.
e.g. when a table is cached, you are no longer accessing the original data source. But the data may not be complete since an ongoing cache refresh is in progress.