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 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
Connections
Oauth2 Callback
This callback/webhook is used while creating a new connection with Oauth2. See https://docs.peaka.com/how-to-guides/how-to-create-oauth2-based-connections-via-peaka for more information.
POST
/
connections
/
{projectId}
/
oauth2
Copy
Ask AI
curl --request POST \
--url https://partner.peaka.studio/api/v1/connections/{projectId}/oauth2 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"queryParameters": "code=1234&state=xyz¶m1=value1¶m2=value2"
}'
Copy
Ask AI
{
"id": "6243f42a-42d0-4821-a90f-763cda6cda50",
"name": "exampleOauth2Connection",
"type": "google_analytics"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
ID of the project
Body
application/json
Oauth2 Callback Body
The body is of type object
.
Response
200 - application/json
Connection created successfully
The response is of type object
.
Copy
Ask AI
curl --request POST \
--url https://partner.peaka.studio/api/v1/connections/{projectId}/oauth2 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"queryParameters": "code=1234&state=xyz¶m1=value1¶m2=value2"
}'
Copy
Ask AI
{
"id": "6243f42a-42d0-4821-a90f-763cda6cda50",
"name": "exampleOauth2Connection",
"type": "google_analytics"
}
Assistant
Responses are generated using AI and may contain mistakes.