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 -> Queries
Create Query
POST
/
data
/
projects
/
{projectId}
/
queries
curl --request POST \
--url https://partner.peaka.studio/api/v1/data/projects/{projectId}/queries \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"displayName": "sampleQuery",
"inputQuery": "SELECT * from \"mycatalog\".payment.customers"
}'
{
"id": "<string>",
"displayName": "<string>",
"name": "<string>",
"inputQuery": "<string>",
"inputQueryRefId": "<string>",
"queryType": "<string>",
"schedule": {
"expression": "<string>"
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Body
application/json
Query Request
The body is of type object
.
Response
200 - application/json
Query created
The response is of type object
.
curl --request POST \
--url https://partner.peaka.studio/api/v1/data/projects/{projectId}/queries \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"displayName": "sampleQuery",
"inputQuery": "SELECT * from \"mycatalog\".payment.customers"
}'
{
"id": "<string>",
"displayName": "<string>",
"name": "<string>",
"inputQuery": "<string>",
"inputQueryRefId": "<string>",
"queryType": "<string>",
"schedule": {
"expression": "<string>"
}
}