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
Connections
Update Connection
Update a connection
PUT
/
connections
/
{projectId}
/
{connectionId}
Copy
Ask AI
HttpResponse<String> response = Unirest.put("https://partner.peaka.studio/api/v1/connections/{projectId}/{connectionId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"exampleHubspotConnection\",\n \"type\": \"hubspot\",\n \"credential\": {\n \"clientId\": \"15d6b8c5-48ea-4955-8ce5-d04bb9adad25\",\n \"clientSecret\": \"64d70b56-ae19-4fee-9fa2-3e9113bcb202\",\n \"refreshToken\": \"eu1-eae3-1af4-583d-91d4-f6414699feea\"\n }\n}")
.asString();
Copy
Ask AI
{
"id": "<string>",
"name": "<string>",
"type": "<string>",
"url": "<string>"
}
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
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
.
Copy
Ask AI
HttpResponse<String> response = Unirest.put("https://partner.peaka.studio/api/v1/connections/{projectId}/{connectionId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"exampleHubspotConnection\",\n \"type\": \"hubspot\",\n \"credential\": {\n \"clientId\": \"15d6b8c5-48ea-4955-8ce5-d04bb9adad25\",\n \"clientSecret\": \"64d70b56-ae19-4fee-9fa2-3e9113bcb202\",\n \"refreshToken\": \"eu1-eae3-1af4-583d-91d4-f6414699feea\"\n }\n}")
.asString();
Copy
Ask AI
{
"id": "<string>",
"name": "<string>",
"type": "<string>",
"url": "<string>"
}
Assistant
Responses are generated using AI and may contain mistakes.