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
- GETGet Project Metadata
- PUTGenerate categorical values from the column.
- DELDelete categorical values from the column meta and remove the scheduled job
- GETSemantic query golden sqls for the project.
- GETList of golden sqls for the project.
- POSTCreate golden sql for the project
- DELDelete golden sql from the project.
- GETSemantic query metadata for the project.
- GETGenerate sample ai questions for the project
- POSTRefresh Project Metadata
- GETGet Metadata Refresh Job Callback
- POSTRegister Metadata Refresh Job Callback
- DELUnregister Metadata Refresh Job Callback
- GETGet Metadata Refresh Job Status
- GETGet Project Catalog Metadata Relations
- POSTAdd Relation To Metadata
- PUTUpdate Relation From Metadata
- DELDelete Relation From Metadata
- POSTGenerate semantics for the table
- PUTUpdate Metadata ai usage per catalog level
- PUTUpdate Metadata ai usage per schema level
- PUTUpdate Metadata
AI -- AgentV2
Data -- SQL
Create golden sql for the project
Copy
Ask AI
curl --request POST \
--url https://partner.peaka.studio/api/v1/metadata/{projectId}/golden-sqls \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"prompt": "<string>",
"sql": "<string>"
}
'Copy
Ask AI
{}Data -- Metadata
Create golden sql for the project
POST
/
metadata
/
{projectId}
/
golden-sqls
Create golden sql for the project
Copy
Ask AI
curl --request POST \
--url https://partner.peaka.studio/api/v1/metadata/{projectId}/golden-sqls \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"prompt": "<string>",
"sql": "<string>"
}
'Copy
Ask AI
{}
Authorizations
Use the Authorization header with the value 'Bearer
Path Parameters
Response
200 - */*
OK
⌘I