API Documentation
Organization -> Organizations
Organization -> Workspaces
Organization -> Projects
Projects (Deprecated)
Projects -> Api Key
Connections
Data -> Catalogs
Data -> Internal Tables
Data -> Queries
Data -> Semantic Catalogs
Data -> Cache
Embedded Peaka Api
Supported Drivers
Data -> Metadata
- PUTUpdate Metadata
- PUTUpdate Relation From Metadata
- DELDelete Relation From Metadata
- PUTGenerate categorical values from the the column.
- POSTGenerate semantics for the table
- POSTAdd Relation To Metadata
- GETList of golden sqls for the project.
- POSTCreate golden sql for the project
- GETGet Project Metadata
- GETGet Project Catalog Metadata Relations
- GETGenerate sample ai questions for the project
- DELDelete golden sql from the project.
Data -> Catalogs
List Tables
GET
/
data
/
projects
/
{projectId}
/
catalogs
/
{catalogId}
/
schemas
/
{schemaName}
/
tables
curl --request GET \
--url https://partner.peaka.studio/api/v1/data/projects/{projectId}/catalogs/{catalogId}/schemas/{schemaName}/tables \
--header 'Authorization: Bearer <token>'
[
{
"catalogId": "544639856899260964",
"catalogName": "airtable2",
"schemaName": "test",
"tableName": "projects",
"isCacheable": false,
"isDynamicTable": false,
"isCached": false
},
{
"catalogId": "544639856899260964",
"catalogName": "airtable2",
"schemaName": "test",
"tableName": "testTable",
"isCacheable": false,
"isDynamicTable": false,
"isCached": false
}
]
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
ID of the project
ID of the catalog
Name of the schema
Response
200 - application/json
Successful operation
The response is of type object[]
.
curl --request GET \
--url https://partner.peaka.studio/api/v1/data/projects/{projectId}/catalogs/{catalogId}/schemas/{schemaName}/tables \
--header 'Authorization: Bearer <token>'
[
{
"catalogId": "544639856899260964",
"catalogName": "airtable2",
"schemaName": "test",
"tableName": "projects",
"isCacheable": false,
"isDynamicTable": false,
"isCached": false
},
{
"catalogId": "544639856899260964",
"catalogName": "airtable2",
"schemaName": "test",
"tableName": "testTable",
"isCacheable": false,
"isDynamicTable": false,
"isCached": false
}
]