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 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 -- Agent
AI -- AgentV2
Data -- SQL
Supported Drivers
List Supported Drivers
GET
/
supportedDrivers
Copy
Ask AI
curl --request GET \
--url https://partner.peaka.studio/api/v1/supportedDrivers \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
{
"JDBC": "jdbc:peaka://dbc.peaka.studio:4567/?extraCredentials=peakaKey:gk4aUnCO.IYxkP1NxP67YkVViqYGZd4INpUAr04TE",
"SQL_ALCHEMY": "peaka://dbc.peaka.studio:4567/{catalogName}?http_scheme=https&extra_credential=[[\"peakaKey\",\"gk4aUnCO.IYxkP1NxP67YkVViqYGZd4INpUAr04TE\"]]&access_token=true"
}
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
Query Parameters
Catalog name.
Drivers such as sql_alchemy supports only one catalog at a time. So specific catalog name must be provided in order to use.
Response
200 - */*
List of supported drivers
The response is of type string
.
Copy
Ask AI
curl --request GET \
--url https://partner.peaka.studio/api/v1/supportedDrivers \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
{
"JDBC": "jdbc:peaka://dbc.peaka.studio:4567/?extraCredentials=peakaKey:gk4aUnCO.IYxkP1NxP67YkVViqYGZd4INpUAr04TE",
"SQL_ALCHEMY": "peaka://dbc.peaka.studio:4567/{catalogName}?http_scheme=https&extra_credential=[[\"peakaKey\",\"gk4aUnCO.IYxkP1NxP67YkVViqYGZd4INpUAr04TE\"]]&access_token=true"
}
Assistant
Responses are generated using AI and may contain mistakes.