API Documentation
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.
Read Catalog
GET
/
data
/
projects
/
{projectId}
/
catalogs
/
{catalogId}
curl --request GET \
--url https://partner.peaka.studio/api/v1/data/projects/{projectId}/catalogs/{catalogId}
{
"id": "627249916703408649",
"name": "exampleairtablecatalog",
"displayName": "exampleAirtableCatalog",
"catalogType": "airtable",
"connectionId": "8db17e23-29de-4dab-8886-af9717e0e74311"
}
Response
200 - application/json
Successful operation
This class represents a Catalog. It contains the id, name, display name, type, and connection ID of the catalog.
The ID of the catalog.
The name of the catalog.
The display name of the catalog.
The type of the catalog.
The connection ID of the catalog.
curl --request GET \
--url https://partner.peaka.studio/api/v1/data/projects/{projectId}/catalogs/{catalogId}
{
"id": "627249916703408649",
"name": "exampleairtablecatalog",
"displayName": "exampleAirtableCatalog",
"catalogType": "airtable",
"connectionId": "8db17e23-29de-4dab-8886-af9717e0e74311"
}