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
Data -- Parametric Tables
Embedded Peaka Api
Supported Drivers
Data -- Metadata
- PUTUpdate Metadata ai usage per catalog level
- PUTUpdate Metadata ai usage per schema level
- PUTUpdate Metadata
- PUTUpdate Relation From Metadata
- DELDelete Relation From Metadata
- PUTGenerate categorical values from the column.
- DELDelete categorical values from the column meta and remove the scheduled job
- POSTGenerate semantics for the table
- POSTAdd Relation To Metadata
- POSTRefresh Project 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
- GETSemantic query metadata for the project.
- GETSemantic query golden sqls for the project.
- DELDelete golden sql from the project.
AI -- Agent
AI -- AgentV2
Data -- SQL
Data -- Queries
Execute Query
POST
/
data
/
projects
/
{projectId}
/
queries
/
execute
Copy
Ask AI
curl --request POST \
--url https://partner.peaka.studio/api/v1/data/projects/{projectId}/queries/execute \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"from": [
{
"catalogName": "peaka",
"schemaName": "query",
"tableName": "samplequery"
}
]
}'
Copy
Ask AI
{
"columns": [
{
"catalogId": "2",
"catalogName": "peaka",
"schemaName": "query",
"tableName": "samplequery",
"columnName": "amount"
}
],
"data": [
[
{
"name": "amount",
"displayName": "amount",
"dataType": "bigint",
"value": "75",
"order": 0
}
],
[
{
"name": "amount",
"displayName": "amount",
"dataType": "bigint",
"value": "75",
"order": 0
}
],
[
{
"name": "amount",
"displayName": "amount",
"dataType": "bigint",
"value": "75",
"order": 0
}
]
]
}
Authorizations
Use the Authorization header with the value 'Bearer <apiKey>' to authenticate. Partner API Keys have full access; Project API Keys are limited to their project scope. Learn more: https://docs.peaka.com/api-reference/authentication
Path Parameters
Body
application/json
Execute Query Request
The body is of type object
.
Response
200 - application/json
Query Result
Represents the result of a query.
Copy
Ask AI
curl --request POST \
--url https://partner.peaka.studio/api/v1/data/projects/{projectId}/queries/execute \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"from": [
{
"catalogName": "peaka",
"schemaName": "query",
"tableName": "samplequery"
}
]
}'
Copy
Ask AI
{
"columns": [
{
"catalogId": "2",
"catalogName": "peaka",
"schemaName": "query",
"tableName": "samplequery",
"columnName": "amount"
}
],
"data": [
[
{
"name": "amount",
"displayName": "amount",
"dataType": "bigint",
"value": "75",
"order": 0
}
],
[
{
"name": "amount",
"displayName": "amount",
"dataType": "bigint",
"value": "75",
"order": 0
}
],
[
{
"name": "amount",
"displayName": "amount",
"dataType": "bigint",
"value": "75",
"order": 0
}
]
]
}
Assistant
Responses are generated using AI and may contain mistakes.