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.
Connections
Update Connection
Update a connection
PUT
/
connections
/
{projectId}
/
{connectionId}
curl --request PUT \
--url https://partner.peaka.studio/api/v1/connections/{projectId}/{connectionId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "exampleHubspotConnection",
"type": "hubspot",
"credential": {
"clientId": "15d6b8c5-48ea-4955-8ce5-d04bb9adad25",
"clientSecret": "64d70b56-ae19-4fee-9fa2-3e9113bcb202",
"refreshToken": "eu1-eae3-1af4-583d-91d4-f6414699feea"
}
}'
{
"id": "<string>",
"name": "<string>",
"type": "<string>",
"url": "<string>"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
ID of the project
ID of the connection
Body
application/json
Connection Request
The body is of type object
.
Response
200 - */*
OK
The response is of type object
.
curl --request PUT \
--url https://partner.peaka.studio/api/v1/connections/{projectId}/{connectionId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "exampleHubspotConnection",
"type": "hubspot",
"credential": {
"clientId": "15d6b8c5-48ea-4955-8ce5-d04bb9adad25",
"clientSecret": "64d70b56-ae19-4fee-9fa2-3e9113bcb202",
"refreshToken": "eu1-eae3-1af4-583d-91d4-f6414699feea"
}
}'
{
"id": "<string>",
"name": "<string>",
"type": "<string>",
"url": "<string>"
}