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.
Embedded Peaka Api
Init Session
Init session for the user
POST
/
ui
/
initSession
curl --request POST \
--url https://partner.peaka.studio/api/v1/ui/initSession \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"timeoutInSeconds": 300,
"projectId": "projectId",
"theme": "dark",
"themeOverride": true,
"featureFlags": {
"feature1": true,
"feature2": false
}
}'
{
"sessionUrl": "https://partner.peaka.studio/api/v1/ui/session?code=2eccdbf31efa110943b470b9023e9a52587c166e4d1c21f23fabbcd7de5b74ab"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Session Initialization Request
The body is of type object
.
Response
200 - */*
Session created successfully
The response is of type object
.
curl --request POST \
--url https://partner.peaka.studio/api/v1/ui/initSession \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"timeoutInSeconds": 300,
"projectId": "projectId",
"theme": "dark",
"themeOverride": true,
"featureFlags": {
"feature1": true,
"feature2": false
}
}'
{
"sessionUrl": "https://partner.peaka.studio/api/v1/ui/session?code=2eccdbf31efa110943b470b9023e9a52587c166e4d1c21f23fabbcd7de5b74ab"
}