API Documentation
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
List Connections
List all connections for a project
GET
/
connections
/
{projectId}
curl --request GET \
--url https://partner.peaka.studio/api/v1/connections/{projectId}
[
{
"id": "c6883de8-78ab-49fb-93c0-70a13652a341",
"name": "Stripe Code2",
"type": "stripe"
},
{
"id": "81e6dfd0-4c88-4e81-a28b-422e89cc07c7",
"name": "airtable",
"type": "airtable"
},
{
"id": "8db17e23-29de-4dab-8886-af9717e0e742",
"name": "airtable2",
"type": "airtable"
},
{
"id": "22706960-023c-411e-a3ac-62d286fa6685",
"name": "exampleAirtableConnection",
"type": "airtable"
}
]
Path Parameters
ID of the project
Response
200 - application/json
List of Connections
Connection ID
Name of the connection
Type of connection.
Example: airtable for AirTable, stripe for Stripe, hubspot_access_token for HubSpot (with Access Token), etc.
Exact list can be fetched by following url: /connections/config
Oauth callback url if the connection is Oauth based.
curl --request GET \
--url https://partner.peaka.studio/api/v1/connections/{projectId}
[
{
"id": "c6883de8-78ab-49fb-93c0-70a13652a341",
"name": "Stripe Code2",
"type": "stripe"
},
{
"id": "81e6dfd0-4c88-4e81-a28b-422e89cc07c7",
"name": "airtable",
"type": "airtable"
},
{
"id": "8db17e23-29de-4dab-8886-af9717e0e742",
"name": "airtable2",
"type": "airtable"
},
{
"id": "22706960-023c-411e-a3ac-62d286fa6685",
"name": "exampleAirtableConnection",
"type": "airtable"
}
]