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
Organization -- Projects
Read Project
GET
/
organizations
/
{organizationId}
/
workspaces
/
{workspaceId}
/
projects
/
{projectId}
Copy
Ask AI
curl --request GET \
--url https://partner.peaka.studio/api/v1/organizations/{organizationId}/workspaces/{workspaceId}/projects/{projectId} \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
{
"id": "SksnYuxH",
"name": "Anapp23334",
"description": null,
"domain": "anapp2-rfto",
"webhookBaseUrl": "https://anapp2-rfto--test.api.peaka.host",
"createdAt": "2023-08-21T11:09:04.699714310Z",
"workspaceId": "d7f282d2-b392-4b5c-8cea-05f7523df2d2"
}
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
Response
200 - application/json
Successful operation
Project
Copy
Ask AI
curl --request GET \
--url https://partner.peaka.studio/api/v1/organizations/{organizationId}/workspaces/{workspaceId}/projects/{projectId} \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
{
"id": "SksnYuxH",
"name": "Anapp23334",
"description": null,
"domain": "anapp2-rfto",
"webhookBaseUrl": "https://anapp2-rfto--test.api.peaka.host",
"createdAt": "2023-08-21T11:09:04.699714310Z",
"workspaceId": "d7f282d2-b392-4b5c-8cea-05f7523df2d2"
}
Assistant
Responses are generated using AI and may contain mistakes.