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
- 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
AI -- AgentV2
Data -- SQL
Data -- Catalogs
List Catalogs
GET
/
data
/
projects
/
{projectId}
/
catalogs
Copy
Ask AI
curl --request GET \
--url https://partner.peaka.studio/api/v1/data/projects/{projectId}/catalogs \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
[
{
"id": "1",
"name": "peaka",
"displayName": "Peaka",
"catalogType": "internal",
"connectionId": null
},
{
"id": "2",
"name": "peaka",
"displayName": "Peaka Query",
"catalogType": "query",
"connectionId": null
},
{
"id": "555414570395501064",
"name": "examplename34",
"displayName": "exampleName34",
"catalogType": "stripe",
"connectionId": "fe47b030-3718-4537-a6ba-eaa93c7204ee"
},
{
"id": "555611268656923356",
"name": "examplename35",
"displayName": "exampleName35",
"catalogType": "segment",
"connectionId": "fe47b030-3718-4537-a6ba-eaa93c7204ee"
},
{
"id": "625151643029078208",
"name": "exampleairtablecatalog2",
"displayName": "exampleAirtableCatalog2",
"catalogType": "airtable",
"connectionId": "8db17e23-29de-4dab-8886-af9717e0e742"
}
]
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
Response
200 - application/json
Successful operation
The response is of type object[]
.
Copy
Ask AI
curl --request GET \
--url https://partner.peaka.studio/api/v1/data/projects/{projectId}/catalogs \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
[
{
"id": "1",
"name": "peaka",
"displayName": "Peaka",
"catalogType": "internal",
"connectionId": null
},
{
"id": "2",
"name": "peaka",
"displayName": "Peaka Query",
"catalogType": "query",
"connectionId": null
},
{
"id": "555414570395501064",
"name": "examplename34",
"displayName": "exampleName34",
"catalogType": "stripe",
"connectionId": "fe47b030-3718-4537-a6ba-eaa93c7204ee"
},
{
"id": "555611268656923356",
"name": "examplename35",
"displayName": "exampleName35",
"catalogType": "segment",
"connectionId": "fe47b030-3718-4537-a6ba-eaa93c7204ee"
},
{
"id": "625151643029078208",
"name": "exampleairtablecatalog2",
"displayName": "exampleAirtableCatalog2",
"catalogType": "airtable",
"connectionId": "8db17e23-29de-4dab-8886-af9717e0e742"
}
]
Assistant
Responses are generated using AI and may contain mistakes.