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
Projects (Deprecated)
Create Project
deprecated
POST
/
projects
Create Project
Copy
Ask AI
curl --request POST \
--url https://partner.peaka.studio/api/v1/projects \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "Sample Project Name"
}'
Copy
Ask AI
{
"id": "URNg0GIj",
"name": "Sample Project Name",
"description": "Non accusantium ducimus accusantium. Laborum eum accusamus sit sit hic eaque doloremque. Occaecati blanditiis facere consequuntur consectetur culpa reiciendis hic tempore dolorem. Saepe impedit nam necessitatibus maxime numquam voluptatum cum. Adipisci mollitia blanditiis sint inventore ex commodi occaecati ipsam quas.",
"domain": "sampleprojectname-cdcn",
"webhookBaseUrl": "https://sampleprojectname-cdcn--test.api.peaka.host",
"createdAt": "2024-09-10T10:11:02.385253956Z"
}
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
Body
application/json
Project to create
The body is of type object
.
Response
200 - application/json
Project created
Project
Create Project
Copy
Ask AI
curl --request POST \
--url https://partner.peaka.studio/api/v1/projects \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "Sample Project Name"
}'
Copy
Ask AI
{
"id": "URNg0GIj",
"name": "Sample Project Name",
"description": "Non accusantium ducimus accusantium. Laborum eum accusamus sit sit hic eaque doloremque. Occaecati blanditiis facere consequuntur consectetur culpa reiciendis hic tempore dolorem. Saepe impedit nam necessitatibus maxime numquam voluptatum cum. Adipisci mollitia blanditiis sint inventore ex commodi occaecati ipsam quas.",
"domain": "sampleprojectname-cdcn",
"webhookBaseUrl": "https://sampleprojectname-cdcn--test.api.peaka.host",
"createdAt": "2024-09-10T10:11:02.385253956Z"
}
Assistant
Responses are generated using AI and may contain mistakes.