Organization -> Projects
Update Project
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
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.
Organization -> Projects
Update Project
PUT
/
organizations
/
{organizationId}
/
workspaces
/
{workspaceId}
/
projects
/
{projectId}
curl --request PUT \
--url https://partner.peaka.studio/api/v1/organizations/{organizationId}/workspaces/{workspaceId}/projects/{projectId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "Updated Project Name",
"description": "Iste aut quo maxime dolorem atque. Alias neque porro. Fugiat ipsam similique voluptate quam libero deserunt consequuntur dolorum nobis."
}'
{
"id": "URNg0GIj",
"name": "Updated Project Name",
"description": "Iste aut quo maxime dolorem atque. Alias neque porro. Fugiat ipsam similique voluptate quam libero deserunt consequuntur dolorum nobis.",
"domain": "sampleprojectname-cdcn",
"webhookBaseUrl": null,
"createdAt": "2024-09-10T10:11:02.385253956Z",
"workspaceId": "d7f282d2-b392-4b5c-8cea-05f7523df2d2"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Project to update
The body is of type object
.
Response
200 - application/json
Project updated
Project
curl --request PUT \
--url https://partner.peaka.studio/api/v1/organizations/{organizationId}/workspaces/{workspaceId}/projects/{projectId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "Updated Project Name",
"description": "Iste aut quo maxime dolorem atque. Alias neque porro. Fugiat ipsam similique voluptate quam libero deserunt consequuntur dolorum nobis."
}'
{
"id": "URNg0GIj",
"name": "Updated Project Name",
"description": "Iste aut quo maxime dolorem atque. Alias neque porro. Fugiat ipsam similique voluptate quam libero deserunt consequuntur dolorum nobis.",
"domain": "sampleprojectname-cdcn",
"webhookBaseUrl": null,
"createdAt": "2024-09-10T10:11:02.385253956Z",
"workspaceId": "d7f282d2-b392-4b5c-8cea-05f7523df2d2"
}