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.
Create a semantic catalog
POST
/
data
/
projects
/
{projectId}
/
semantic-catalogs
curl --request POST \
--url https://partner.peaka.studio/api/v1/data/projects/{projectId}/semantic-catalogs \
--header 'Content-Type: application/json' \
--data '{
"name": "myCatalog"
}'
{
"id": "688890918747898103",
"name": "myCatalog",
"displayName": "myCatalog",
"type": "SEMANTIC"
}
Path Parameters
Body
application/json
Semantic Catalog Request
Name of the catalog
Response
200 - application/json
Catalog created
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 POST \
--url https://partner.peaka.studio/api/v1/data/projects/{projectId}/semantic-catalogs \
--header 'Content-Type: application/json' \
--data '{
"name": "myCatalog"
}'
{
"id": "688890918747898103",
"name": "myCatalog",
"displayName": "myCatalog",
"type": "SEMANTIC"
}