Every API here is available over the APIs.io API and to AI agents over MCP.
{"openapi": "3.0.1", "info": {"title": "Peaka Gateway API", "description": "The Peaka Partner API is a powerful gateway that lets you seamlessly integrate Peaka's features into your own applications and services. With secure access provided through a unique API key, you can leverage the full potential of Peaka's capabilities to enhance your user experience and streamline operations.\n\n**Resources:** [OpenAPI specification](https://www.peaka.com/api/peaka-openapi.json) · [Postman Collection](https://www.postman.com/peaka-api/peaka-api/collection/znssuf9/partner-api)\n\n## Key Features\n\n- **Secure Authentication**: Access the API with confidence using the apiKey provided by Peaka, ensuring secure and authorized interactions.\n- **Robust Functionality**: Utilize a wide range of functions, from data retrieval to executing complex operations, all tailored to meet diverse integration needs.\n- **Real-Time Data Access**: Retrieve up-to-the-minute information to keep your services synchronized with the latest developments within Peaka.\n- **Customizable Integration**: Tailor the API's extensive features to fit your platform's specific requirements, providing a personalized experience for your users.\n- **Scalability**: Designed to handle requests at scale, the Peaka Partner API can accommodate growing traffic as your business expands.\n- **Dedicated Support**: Benefit from Peaka's dedicated support for API integration and usage.\n\n## Getting Started\n\n- **API Key Activation**: Create your unique apiKey from the Developer section in Peaka Studio, following the [Partner API Key management guide](https://www.peaka.com/docs/cookbook/how-to-manage-partner-api-key). This key is essential for all API requests.\n- **Documentation**: Comprehensive documentation is provided to guide you through the integration process, detailing available endpoints, request/response formats, and best practices.\n\n## Support and Assistance\n\nOur dedicated team is available to assist you throughout the integration process and beyond. Should you have any questions or require technical support, please reach out to our support channel.\n", "version": "1.0"}, "servers": [{"url": "https://partner.peaka.studio/api/v1", "description": "Default Server URL (US Zone)"}, {"url": "https://partner.eu.peaka.studio/api/v1", "description": "EU Zone"}], "security": [{"bearerAuth": []}], "paths": {"/organizations": {"get": {"tags": ["Organization -- Organizations"], "summary": "List Organizations", "description": "<span class=\"key-chips\"><span class=\"key-chip key-partner\">Partner API Key</span></span>\n\nRetrieves all the organizations accessible by the authenticated user.\n\nAn Organization is the highest-level resource that can contain multiple Workspaces.\n", "operationId": "listOrganizations", "responses": {"200": {"description": "List of Organizations", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Organization"}, "examples": {"List Organizations Example": {"description": "List Organizations Example", "value": [{"id": "d0d3c83f-29ed-4f2e-899d-1bfa00eb3cef", "name": "ABC Organization", "owner": "1673d60f-a0ea-41f4-9420-c91dbc2864f5", "createdAt": "2025-03-25T12:28:48.737355Z", "iconFileId": null, "description": "Default Organization"}]}}}}}}, "x-mint": {"content": "<span style={{display: \"flex\", gap: \"10px\", flexDirection: \"row\", alignItems: \"center\"}}>\n <img src=\"https://cdn.peaka.com/badges/partner-api-key-badge.png\"/>\n</span>\n"}}}, "/organizations/{organizationId}": {"get": {"tags": ["Organization -- Organizations"], "summary": "Read Organization", "description": "<span class=\"key-chips\"><span class=\"key-chip key-partner\">Partner API Key</span></span>\n\nReturns the specified Organization.\n\nAn Organization is the highest-level resource that can contain multiple Workspaces.\n", "operationId": "getOrganization", "parameters": [{"name": "organizationId", "in": "path", "description": "ID of the Organization", "required": true, "schema": {"type": "string"}, "example": "8db17e23-29de-4dab-8886-af9717e0e742"}], "responses": {"200": {"description": "Successful operation", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Organization"}, "examples": {"Read Organization Example": {"description": "Read Organization Example", "value": {"id": "d0d3c83f-29ed-4f2e-899d-1bfa00eb3cef", "name": "ABC Organization", "owner": "1673d60f-a0ea-41f4-9420-c91dbc2864f5", "createdAt": "2025-03-25T12:28:48.737355Z", "iconFileId": null, "description": "Default Organization"}}}}}}}, "x-mint": {"content": "<span style={{display: \"flex\", gap: \"10px\", flexDirection: \"row\", alignItems: \"center\"}}>\n <img src=\"https://cdn.peaka.com/badges/partner-api-key-badge.png\"/>\n</span>\n"}}}, "/organizations/{organizationId}/workspaces": {"get": {"tags": ["Organization -- Workspaces"], "summary": "List Workspaces", "description": "<span class=\"key-chips\"><span class=\"key-chip key-partner\">Partner API Key</span></span>\n\nReturns all workspaces under the specified Organization.\n\nA Workspace is a collaborative environment within an Organization that groups Projects together. It facilitates team collaboration, resource management, and organization of data operations.\n\nThe hierarchical structure in Peaka is:\n\n<code>Organization (top-level) → Workspace → Project</code>\n\nProjects contain data catalogs and workflows that teams manage within a Workspace.\n", "operationId": "listWorkspaces", "parameters": [{"name": "organizationId", "in": "path", "description": "ID of the Organization", "required": true, "schema": {"type": "string"}, "example": "d0d3c83f-29ed-4f2e-899d-1bfa00eb3cef"}], "responses": {"200": {"description": "List of Workspaces", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Workspace"}, "examples": {"List Workspace Example": {"description": "List Workspace Example", "value": [{"id": "56d43968-e31d-4010-9b75-018a79a51b17", "name": "workspace 1", "createdBy": "1673d60f-a0ea-41f4-9420-c91dbc2864f5", "organizationId": "d0d3c83f-29ed-4f2e-899d-1bfa00eb3cef", "description": "sample description", "createdAt": "2025-04-17T08:08:15.687751Z", "defaultWorkspace": false}, {"id": "78cf8c83-8569-4d7c-a1ce-404dee7c5c6b", "name": "workspace 2", "createdBy": "1673d60f-a0ea-41f4-9420-c91dbc2864f5", "organizationId": "d0d3c83f-29ed-4f2e-899d-1bfa00eb3cef", "description": "sample description", "createdAt": "2025-04-17T08:05:58.312996Z", "defaultWorkspace": false}, {"id": "eaa442d7-82ac-4a65-b302-093d0465eb67", "name": "Default Workspace", "createdBy": "1673d60f-a0ea-41f4-9420-c91dbc2864f5", "organizationId": "d0d3c83f-29ed-4f2e-899d-1bfa00eb3cef", "description": "Default Workspace", "createdAt": "2025-03-25T12:28:51.147125Z", "defaultWorkspace": true}]}}}}}}, "x-mint": {"content": "<span style={{display: \"flex\", gap: \"10px\", flexDirection: \"row\", alignItems: \"center\"}}>\n <img src=\"https://cdn.peaka.com/badges/partner-api-key-badge.png\"/>\n</span>\n"}}, "post": {"tags": ["Organization -- Workspaces"], "summary": "Create Workspace", "description": "<span class=\"key-chips\"><span class=\"key-chip key-partner\">Partner API Key</span></span>\n\nThe endpoint allows you to create a new Workspace within an Organization.\n\nA Workspace is a collaborative environment within an Organization that groups Projects together. It facilitates team collaboration, resource management, and organization of data operations.\n\nThe hierarchical structure in Peaka is:\n\n<code>Organization (top-level) → Workspace → Project</code>\n\nProjects contain data catalogs and workflows that teams manage within a Workspace.\n", "operationId": "createWorkspace", "parameters": [{"name": "organizationId", "in": "path", "description": "Organization ID", "required": true, "schema": {"type": "string"}, "example": "d0d3c83f-29ed-4f2e-899d-1bfa00eb3cef"}], "requestBody": {"description": "Create Workspace", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/WorkspaceRequest"}, "examples": {"Create Workspace Example": {"description": "Create Workspace Example", "value": {"name": "workspace 1", "description": "workspace description"}}}}}, "required": true}, "responses": {"200": {"description": "Successful operation", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Workspace"}, "examples": {"Create Workspace Example": {"description": "Create Workspace Example", "value": {"id": "8eefb5a9-59f7-43cc-bacb-f0b0e0d1b0ea", "name": "workspace 1", "createdBy": "1673d60f-a0ea-41f4-9420-c91dbc2864f5", "organizationId": "d0d3c83f-29ed-4f2e-899d-1bfa00eb3cef", "description": "workspace description", "createdAt": null, "defaultWorkspace": false}}}}}}}, "x-mint": {"content": "<span style={{display: \"flex\", gap: \"10px\", flexDirection: \"row\", alignItems: \"center\"}}>\n <img src=\"https://cdn.peaka.com/badges/partner-api-key-badge.png\"/>\n</span>\n"}}}, "/organizations/{organizationId}/workspaces/{workspaceId}": {"get": {"tags": ["Organization -- Workspaces"], "summary": "Read Workspace", "description": "<span class=\"key-chips\"><span class=\"key-chip key-partner\">Partner API Key</span></span>\n\nReturns details of a specified Workspace, which is a collaborative environment within an Organization that groups Projects together.\n\nA Workspace facilitates team collaboration, resource management, and organization of data operations.\n\nThe hierarchical structure in Peaka is:\n\n<code>Organization (top-level) → Workspace → Project</code>\n\nProjects contain data catalogs and workflows that teams manage within a Workspace.\n", "operationId": "getWorkspace", "parameters": [{"name": "organizationId", "in": "path", "description": "Organization ID", "required": true, "schema": {"type": "string"}, "example": "d0d3c83f-29ed-4f2e-899d-1bfa00eb3cef"}, {"name": "workspaceId", "in": "path", "description": "Workspace ID", "required": true, "schema": {"type": "string"}, "example": "56d43968-e31d-4010-9b75-018a79a51b17"}], "responses": {"200": {"description": "Successful operation", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Workspace"}, "examples": {"Read Workspace example": {"description": "Read Workspace example", "value": {"id": "8eefb5a9-59f7-43cc-bacb-f0b0e0d1b0ea", "name": "workspace 1", "createdBy": "1673d60f-a0ea-41f4-9420-c91dbc2864f5", "organizationId": "d0d3c83f-29ed-4f2e-899d-1bfa00eb3cef", "description": "workspace description", "createdAt": null, "defaultWorkspace": false}}}}}}}, "x-mint": {"content": "<span style={{display: \"flex\", gap: \"10px\", flexDirection: \"row\", alignItems: \"center\"}}>\n <img src=\"https://cdn.peaka.com/badges/partner-api-key-badge.png\"/>\n</span>\n"}}, "put": {"tags": ["Organization -- Workspaces"], "summary": "Update Workspace", "description": "<span class=\"key-chips\"><span class=\"key-chip key-partner\">Partner API Key</span></span>\n\nUpdates the specified Workspace within an Organization.\n\nA Workspace is a collaborative environment within an Organization that groups Projects together, facilitating team collaboration and resource management.\n\nThe hierarchical structure in Peaka is:\n\n<code>Organization (top-level) → Workspace → Project</code>\n\nProjects contain data catalogs and workflows that teams manage within a Workspace.\n", "operationId": "updateWorkspace", "parameters": [{"name": "organizationId", "in": "path", "description": "Organization ID", "required": true, "schema": {"type": "string"}, "example": "d0d3c83f-29ed-4f2e-899d-1bfa00eb3cef"}, {"name": "workspaceId", "in": "path", "description": "Workspace ID", "required": true, "schema": {"type": "string"}, "example": "8eefb5a9-59f7-43cc-bacb-f0b0e0d1b0ea"}], "requestBody": {"description": "Update Workspace", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/WorkspaceRequest"}, "examples": {"Update Workspace Example": {"description": "Update Workspace Example", "value": {"name": "workspace new name", "description": "workspace description"}}}}}, "required": true}, "responses": {"200": {"description": "Successful operation", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Workspace"}, "examples": {"Update Workspace Example": {"description": "Update Workspace Example", "value": {"id": "8eefb5a9-59f7-43cc-bacb-f0b0e0d1b0ea", "name": "workspace new name", "createdBy": "1673d60f-a0ea-41f4-9420-c91dbc2864f5", "organizationId": "d0d3c83f-29ed-4f2e-899d-1bfa00eb3cef", "description": "workspace description", "createdAt": null, "defaultWorkspace": false}}}}}}}, "x-mint": {"content": "<span style={{display: \"flex\", gap: \"10px\", flexDirection: \"row\", alignItems: \"center\"}}>\n <img src=\"https://cdn.peaka.com/badges/partner-api-key-badge.png\"/>\n</span>\n"}}, "delete": {"tags": ["Organization -- Workspaces"], "summary": "Delete Workspace", "description": "<span class=\"key-chips\"><span class=\"key-chip key-partner\">Partner API Key</span></span>\n\nDeletes a specified Workspace within an Organization.\n\nA Workspace is a collaborative environment that groups Projects to facilitate team collaboration and resource management.\n\nThe hierarchical structure in Peaka is:\n\n<code>Organization (top-level) → Workspace → Project</code>\n", "operationId": "deleteWorkspace", "parameters": [{"name": "organizationId", "in": "path", "description": "Organization ID", "required": true, "schema": {"type": "string"}, "example": "d0d3c83f-29ed-4f2e-899d-1bfa00eb3cef"}, {"name": "workspaceId", "in": "path", "description": "Workspace ID", "required": true, "schema": {"type": "string"}, "example": "8eefb5a9-59f7-43cc-bacb-f0b0e0d1b0ea"}], "responses": {"200": {"description": "Successful operation"}}, "x-mint": {"content": "<span style={{display: \"flex\", gap: \"10px\", flexDirection: \"row\", alignItems: \"center\"}}>\n <img src=\"https://cdn.peaka.com/badges/partner-api-key-badge.png\"/>\n</span>\n"}}}, "/organizations/{organizationId}/workspaces/{workspaceId}/projects": {"get": {"tags": ["Organization -- Projects"], "summary": "List Projects", "description": "<span class=\"key-chips\"><span class=\"key-chip key-partner\">Partner API Key</span></span>\n\nFetches all Projects within the given Workspace.\n\nA Project is a unit of work where queries, data tables, and semantic catalogs are managed. Projects live inside Workspaces.\n", "operationId": "listProjects_1", "parameters": [{"name": "organizationId", "in": "path", "description": "ID of the Organization", "required": true, "schema": {"type": "string"}, "example": "d0d3c83f-29ed-4f2e-899d-1bfa00eb3cef"}, {"name": "workspaceId", "in": "path", "description": "ID of the Workspace", "required": true, "schema": {"type": "string"}, "example": "56d43968-e31d-4010-9b75-018a79a51b17"}], "responses": {"200": {"description": "Successful operation", "content": {"application/json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/Project"}}, "examples": {"List of all projects": {"description": "List of all projects", "value": [{"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"}, {"id": "0IQ6f4QB", "name": "App Deneme", "description": null, "domain": "appdeneme-wmdp", "webhookBaseUrl": "https://appdeneme-wmdp--test.api.peaka.host", "createdAt": "2023-12-14T12:38:55.025274418Z", "workspaceId": "d7f282d2-b392-4b5c-8cea-05f7523df2d2"}]}}}}}}, "x-mint": {"content": "<span style={{display: \"flex\", gap: \"10px\", flexDirection: \"row\", alignItems: \"center\"}}>\n <img src=\"https://cdn.peaka.com/badges/partner-api-key-badge.png\"/>\n</span>\n"}}, "post": {"tags": ["Organization -- Projects"], "summary": "Create Project", "description": "<span class=\"key-chips\"><span class=\"key-chip key-partner\">Partner API Key</span></span>\n\nCreates a new Project within the given Workspace.\n\nA Project is a unit of work where queries, data tables, and semantic catalogs are managed. Projects live inside Workspaces.\n", "operationId": "createProject_1", "parameters": [{"name": "organizationId", "in": "path", "description": "ID of the Organization", "required": true, "schema": {"type": "string"}, "example": "d0d3c83f-29ed-4f2e-899d-1bfa00eb3cef"}, {"name": "workspaceId", "in": "path", "description": "ID of the Workspace", "required": true, "schema": {"type": "string"}, "example": "56d43968-e31d-4010-9b75-018a79a51b17"}], "requestBody": {"description": "Project to create", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ProjectRequest"}, "examples": {"Create Project Example": {"description": "Create Project Example", "value": {"name": "Sample Project Name"}}}}}, "required": true}, "responses": {"200": {"description": "Project created", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Project"}, "examples": {"Create Project Example": {"description": "Create Project Example", "value": {"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", "workspaceId": "d7f282d2-b392-4b5c-8cea-05f7523df2d2"}}}}}}}, "x-mint": {"content": "<span style={{display: \"flex\", gap: \"10px\", flexDirection: \"row\", alignItems: \"center\"}}>\n <img src=\"https://cdn.peaka.com/badges/partner-api-key-badge.png\"/>\n</span>\n"}}}, "/organizations/{organizationId}/workspaces/{workspaceId}/projects/{projectId}": {"get": {"tags": ["Organization -- Projects"], "summary": "Read Project", "description": "<span class=\"key-chips\"><span class=\"key-chip key-partner\">Partner API Key</span></span>\n\nReturns details of a specified Project.\n\nA Project is a unit of work where queries, data tables, and semantic catalogs are managed. Projects live inside Workspaces.\n", "operationId": "readProject_1", "parameters": [{"name": "organizationId", "in": "path", "description": "ID of the Organization", "required": true, "schema": {"type": "string"}, "example": "d0d3c83f-29ed-4f2e-899d-1bfa00eb3cef"}, {"name": "workspaceId", "in": "path", "description": "ID of the Workspace", "required": true, "schema": {"type": "string"}, "example": "56d43968-e31d-4010-9b75-018a79a51b17"}, {"name": "projectId", "in": "path", "description": "ID of the Project", "required": true, "schema": {"type": "string"}, "example": "SksnYuxH"}], "responses": {"200": {"description": "Successful operation", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Project"}, "examples": {"Read Project Example": {"description": "Read Project Example", "value": {"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"}}}}}}}, "x-mint": {"content": "<span style={{display: \"flex\", gap: \"10px\", flexDirection: \"row\", alignItems: \"center\"}}>\n <img src=\"https://cdn.peaka.com/badges/partner-api-key-badge.png\"/>\n</span>\n"}}, "put": {"tags": ["Organization -- Projects"], "summary": "Update Project", "description": "<span class=\"key-chips\"><span class=\"key-chip key-partner\">Partner API Key</span></span>\n\nUpdates the specified Project within a Workspace.\n\nA Project is a unit of work where queries, data tables, and semantic catalogs are managed. Projects live inside Workspaces.\n", "operationId": "updateProject_1", "parameters": [{"name": "organizationId", "in": "path", "description": "ID of the Organization", "required": true, "schema": {"type": "string"}, "example": "d0d3c83f-29ed-4f2e-899d-1bfa00eb3cef"}, {"name": "workspaceId", "in": "path", "description": "ID of the Workspace", "required": true, "schema": {"type": "string"}, "example": "56d43968-e31d-4010-9b75-018a79a51b17"}, {"name": "projectId", "in": "path", "description": "ID of the Project", "required": true, "schema": {"type": "string"}, "example": "SksnYuxH"}], "requestBody": {"description": "Project to update", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ProjectRequest"}, "examples": {"Update Project Example": {"description": "Update Project Example", "value": {"name": "Updated Project Name", "description": "Iste aut quo maxime dolorem atque. Alias neque porro. Fugiat ipsam similique voluptate quam libero deserunt consequuntur dolorum nobis."}}}}}, "required": true}, "responses": {"200": {"description": "Project updated", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Project"}, "examples": {"Update Project Example": {"description": "Update Project Example", "value": {"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"}}}}}}}, "x-mint": {"content": "<span style={{display: \"flex\", gap: \"10px\", flexDirection: \"row\", alignItems: \"center\"}}>\n <img src=\"https://cdn.peaka.com/badges/partner-api-key-badge.png\"/>\n</span>\n"}}, "delete": {"tags": ["Organization -- Projects"], "summary": "Delete Project", "description": "<span class=\"key-chips\"><span class=\"key-chip key-partner\">Partner API Key</span></span>\n\nDeletes the specified Project within a Workspace.\n\nA Project is a unit of work where queries, data tables, and semantic catalogs are managed. Projects live inside Workspaces.\n", "operationId": "deleteProject_1", "parameters": [{"name": "organizationId", "in": "path", "description": "ID of the Organization", "required": true, "schema": {"type": "string"}, "example": "d0d3c83f-29ed-4f2e-899d-1bfa00eb3cef"}, {"name": "workspaceId", "in": "path", "description": "ID of the Workspace", "required": true, "schema": {"type": "string"}, "example": "56d43968-e31d-4010-9b75-018a79a51b17"}, {"name": "projectId", "in": "path", "description": "ID of the Project", "required": true, "schema": {"type": "string"}, "example": "SksnYuxH"}], "responses": {"200": {"description": "Project deleted"}}, "x-mint": {"content": "<span style={{display: \"flex\", gap: \"10px\", flexDirection: \"row\", alignItems: \"center\"}}>\n <img src=\"https://cdn.peaka.com/badges/partner-api-key-badge.png\"/>\n</span>\n"}}}, "/projects": {"get": {"tags": ["Projects (Deprecated)"], "summary": "List Projects", "description": "<strong>Deprecated.</strong> Use the <code>List Projects</code> endpoint under Organization instead.\n\nRetrieves all Projects accessible by the authenticated user.\n\nA Project is a unit of work where queries, data tables, and semantic catalogs are managed. Projects live inside Workspaces.\n", "operationId": "listProjects", "responses": {"200": {"description": "Successful operation", "content": {"application/json": {"schema": {"type": "array", "items": {"$ref": "#/components/schemas/Project"}}, "examples": {"List of all projects": {"description": "List of all projects", "value": [{"id": "SksnYuxH", "name": "Anapp23334", "description": null, "domain": "anapp2-rfto", "webhookBaseUrl": "https://anapp2-rfto--test.api.peaka.host", "createdAt": "2023-08-21T11:09:04.699714310Z"}, {"id": "0IQ6f4QB", "name": "App Deneme", "description": null, "domain": "appdeneme-wmdp", "webhookBaseUrl": "https://appdeneme-wmdp--test.api.peaka.host", "createdAt": "2023-12-14T12:38:55.025274418Z"}]}}}}}}, "deprecated": true, "x-mint": {"content": "<span style={{display: \"flex\", gap: \"10px\", flexDirection: \"row\", alignItems: \"center\"}}>\n <img src=\"https://cdn.peaka.com/badges/partner-api-key-badge.png\"/>\n</span>\n"}}, "post": {"tags": ["Projects (Deprecated)"], "summary": "Create Project", "description": "<strong>Deprecated.</strong> Use the <code>Create Project</code> endpoint under Organization instead.\n\nCreates a new Project.\n\nA Project is a unit of work where queries, data tables, and semantic catalogs are managed. Projects live inside Workspaces.\n", "operationId": "createProject", "requestBody": {"description": "Project to create", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ProjectRequest"}, "examples": {"Create Project Example": {"description": "Create Project Example", "value": {"name": "Sample Project Name"}}}}}, "required": true}, "responses": {"200": {"description": "Project created", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Project"}, "examples": {"Create Project Example": {"description": "Create Project Example", "value": {"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"}}}}}}}, "deprecated": true, "x-mint": {"content": "<span style={{display: \"flex\", gap: \"10px\", flexDirection: \"row\", alignItems: \"center\"}}>\n <img src=\"https://cdn.peaka.com/badges/partner-api-key-badge.png\"/>\n</span>\n"}}}, "/projects/{projectId}": {"get": {"tags": ["Projects (Deprecated)"], "summary": "Read Project", "description": "<strong>Deprecated.</strong> Use the <code>Read Project</code> endpoint under Organization instead.\n\nReturns details of a specified Project.\n\nA Project is a unit of work where queries, data tables, and semantic catalogs are managed. Projects live inside Workspaces.\n", "operationId": "readProject", "parameters": [{"name": "projectId", "in": "path", "description": "ID of the Project", "required": true, "schema": {"type": "string"}, "example": "SksnYuxH"}], "responses": {"200": {"description": "Successful operation", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Project"}, "examples": {"Read Project Example": {"description": "Read Project Example", "value": {"id": "SksnYuxH", "name": "Anapp23334", "description": null, "domain": "anapp2-rfto", "webhookBaseUrl": "https://anapp2-rfto--test.api.peaka.host", "createdAt": "2023-08-21T11:09:04.699714310Z"}}}}}}}, "deprecated": true, "x-mint": {"content": "<span style={{display: \"flex\", gap: \"10px\", flexDirection: \"row\", alignItems: \"center\"}}>\n <img src=\"https://cdn.peaka.com/badges/partner-api-key-badge.png\"/>\n</span>\n"}}, "put": {"tags": ["Projects (Deprecated)"], "summary": "Update Project", "description": "<strong>Deprecated.</strong> Use the <code>Update Project</code> endpoint under Organization instead.\n\nUpdates the specified Project.\n\nA Project is a unit of work where queries, data tables, and semantic catalogs are managed. Projects live inside Workspaces.\n", "operationId": "updateProject", "parameters": [{"name": "projectId", "in": "path", "description": "ID of the Project", "required": true, "schema": {"type": "string"}, "example": "SksnYuxH"}], "requestBody": {"description": "Project to update", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ProjectRequest"}, "examples": {"Update Project Example": {"description": "Update Project Example", "value": {"name": "Updated Project Name", "description": "Iste aut quo maxime dolorem atque. Alias neque porro. Fugiat ipsam similique voluptate quam libero deserunt consequuntur dolorum nobis."}}}}}, "required": true}, "responses": {"200": {"description": "Project updated", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Project"}, "examples": {"Update Project Example": {"description": "Update Project Example", "value": {"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"}}}}}}}, "deprecated": true, "x-mint": {"content": "<span style={{display: \"flex\", gap: \"10px\", flexDirection: \"row\", alignItems: \"center\"}}>\n <img src=\"https://cdn.peaka.com/badges/partner-api-key-badge.png\"/>\n</span>\n"}}, "delete": {"tags": ["Projects (Deprecated)"], "summary": "Delete Project", "description": "<strong>Deprecated.</strong> Use the <code>Delete Project</code> endpoint under Organization instead.\n\nDeletes the specified Project.\n\nA Project is a unit of work where queries, data tables, and semantic catalogs are managed. Projects live inside Workspaces.\n", "operationId": "deleteProject", "parameters": [{"name": "projectId", "in": "path", "description": "ID of the Project", "required": true, "schema": {"type": "string"}, "example": "SksnYuxH"}], "responses": {"200": {"description": "Project deleted"}}, "deprecated": true, "x-mint": {"content": "<span style={{display: \"flex\", gap: \"10px\", flexDirection: \"row\", alignItems: \"center\"}}>\n <img src=\"https://cdn.peaka.com/badges/partner-api-key-badge.png\"/>\n</span>\n"}}}, "/projects/{projectId}/apiKeys": {"get": {"tags": ["Projects -- Api Key"], "summary": "List API Keys", "description": "<span class=\"key-chips\"><span class=\"key-chip key-partner\">Partner API Key</span></span>\n\nRetrieves all API Keys associated with the specified Project.\n", "operationId": "listApiKeys", "parameters": [{"name": "projectId", "in": "path", "description": "Project ID", "required": true, "schema": {"type": "string"}, "example": "mtKDhe1U"}], "responses": {"200": {"description": "List of API Keys", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ApiKey"}, "examples": {"List API Keys Example": {"description": "List API Keys Example", "value": [{"name": "test", "apiKey": null, "apiKeyId": "21fd1a8d-88d5-4295-b792-5b2113138057"}]}}}}}}, "x-mint": {"content": "<span style={{display: \"flex\", gap: \"10px\", flexDirection: \"row\", alignItems: \"center\"}}>\n <img src=\"https://cdn.peaka.com/badges/partner-api-key-badge.png\"/>\n</span>\n"}}, "post": {"tags": ["Projects -- Api Key"], "summary": "Create API Key", "description": "<span class=\"key-chips\"><span class=\"key-chip key-partner\">Partner API Key</span></span>\n\nCreates a new API Key for the specified Project. The API Key is used to authenticate requests to the Peaka API on behalf of the Project.\n\nThe full key value is only returned once at creation time. Store it securely, as it cannot be retrieved later.\n", "operationId": "createApiKey", "parameters": [{"name": "projectId", "in": "path", "description": "Project ID", "required": true, "schema": {"type": "string"}, "example": "mtKDhe1U"}], "requestBody": {"description": "API Key request", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ApiKeyRequest"}, "examples": {"API Key Request with Expiration": {"description": "API Key Request with Expiration", "value": {"name": "test", "expiresAt": "2027-09-10T10:11:00Z"}}, "API Key Request With No Expiration": {"description": "API Key Request With No Expiration", "value": {"name": "test"}}}}}, "required": true}, "responses": {"200": {"description": "API Key created", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ApiKey"}, "examples": {"API Key": {"description": "API Key", "value": {"name": "test", "apiKey": "TtgGcQFq.s3fzROFoop8uHG4pS2LYhoqn1rLb6oW6", "apiKeyId": "21fd1a8d-88d5-4295-b792-5b2113138057"}}}}}}}, "x-mint": {"content": "<span style={{display: \"flex\", gap: \"10px\", flexDirection: \"row\", alignItems: \"center\"}}>\n <img src=\"https://cdn.peaka.com/badges/partner-api-key-badge.png\"/>\n</span>\n"}}}, "/projects/{projectId}/apiKeys/{apiKeyId}": {"delete": {"tags": ["Projects -- Api Key"], "summary": "Delete API Key", "description": "<span class=\"key-chips\"><span class=\"key-chip key-partner\">Partner API Key</span></span>\n\nDeletes the specified API Key. Once deleted, any req
# --- truncated at 32 KB (279 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/peaka/refs/heads/main/openapi/_original/peaka-api-openapi.json