# Peaka Gateway API API

**Canonical:** https://apis.io/apis/peaka/peaka-gateway-api-api/  
**Provider:** Peaka — https://apis.io/providers/peaka/  
**Base URL:** https://partner.peaka.studio/api/v1  
**Documentation:** https://www.peaka.com/docs/api-reference/

Peaka Gateway API API is one of 2 APIs that [Peaka](https://apis.io/providers/peaka/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

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 op

## Operations (60 of 137)

| Method | Path | Summary |
|---|---|---|
| GET | `/organizations` | List Organizations |
| GET | `/organizations/{organizationId}` | Read Organization |
| GET | `/organizations/{organizationId}/workspaces` | List Workspaces |
| POST | `/organizations/{organizationId}/workspaces` | Create Workspace |
| GET | `/organizations/{organizationId}/workspaces/{workspaceId}` | Read Workspace |
| PUT | `/organizations/{organizationId}/workspaces/{workspaceId}` | Update Workspace |
| DELETE | `/organizations/{organizationId}/workspaces/{workspaceId}` | Delete Workspace |
| GET | `/organizations/{organizationId}/workspaces/{workspaceId}/projects` | List Projects |
| POST | `/organizations/{organizationId}/workspaces/{workspaceId}/projects` | Create Project |
| GET | `/organizations/{organizationId}/workspaces/{workspaceId}/projects/{projectId}` | Read Project |
| PUT | `/organizations/{organizationId}/workspaces/{workspaceId}/projects/{projectId}` | Update Project |
| DELETE | `/organizations/{organizationId}/workspaces/{workspaceId}/projects/{projectId}` | Delete Project |
| GET | `/projects` | List Projects |
| POST | `/projects` | Create Project |
| GET | `/projects/{projectId}` | Read Project |
| PUT | `/projects/{projectId}` | Update Project |
| DELETE | `/projects/{projectId}` | Delete Project |
| GET | `/projects/{projectId}/apiKeys` | List API Keys |
| POST | `/projects/{projectId}/apiKeys` | Create API Key |
| DELETE | `/projects/{projectId}/apiKeys/{apiKeyId}` | Delete API Key |
| GET | `/connections/config` | List Connection Config |
| GET | `/connections/config/{connectionType}` | Get Connection Config |
| GET | `/connections/{projectId}` | List Connections |
| POST | `/connections/{projectId}` | Create Connection |
| POST | `/connections/{projectId}/oauth2` | Oauth2 Callback |
| GET | `/connections/{projectId}/{connectionId}` | Get Connection |
| PUT | `/connections/{projectId}/{connectionId}` | Update Connection |
| DELETE | `/connections/{projectId}/{connectionId}` | Delete Connection |
| GET | `/connections/{projectId}/{connectionId}/detail` | Get Connection Detail |
| GET | `/data/projects/{projectId}/catalogs` | List Catalogs |
| POST | `/data/projects/{projectId}/catalogs` | Create Catalog |
| GET | `/data/projects/{projectId}/catalogs/{catalogId}` | Read Catalog |
| DELETE | `/data/projects/{projectId}/catalogs/{catalogId}` | Delete Catalog |
| GET | `/data/projects/{projectId}/catalogs/{catalogId}/schemas` | List Schemas |
| GET | `/data/projects/{projectId}/catalogs/{catalogId}/schemas/{schemaName}/tables` | List Tables |
| GET | `/data/projects/{projectId}/catalogs/{catalogId}/schemas/{schemaName}/tables/{tableName}/columns` | List Columns |
| GET | `/data/projects/{projectId}/catalogs/{catalogId}/schemas/{schemaName}/tables/{tableName}/isCached` | Table is Cached |
| GET | `/data/projects/{projectId}/catalogs/{catalogId}/schemas/{schemaName}/tables/{tableName}/statistics` | Table Statistics |
| POST | `/data/projects/{projectId}/catalogs/{catalogId}/share` | Share Catalog |
| POST | `/data/projects/{projectId}/search` | Search |
| GET | `/data/projects/{projectId}/bitable` | List BI Tables |
| POST | `/data/projects/{projectId}/bitable/{tableName}` | Create BI Table |
| DELETE | `/data/projects/{projectId}/bitable/{tableName}` | Delete BI Table |
| GET | `/data/projects/{projectId}/bitable/{tableName}/columns` | List BI Columns |
| POST | `/data/projects/{projectId}/bitable/{tableName}/columns` | Add BI Column |
| PUT | `/data/projects/{projectId}/bitable/{tableName}/columns/{columnName}` | Update BI Column |
| DELETE | `/data/projects/{projectId}/bitable/{tableName}/columns/{columnName}` | Delete BI Column |
| GET | `/data/projects/{projectId}/table` | List Tables |
| POST | `/data/projects/{projectId}/table/{tableName}` | Create Table |
| DELETE | `/data/projects/{projectId}/table/{tableName}` | Delete Table |
| GET | `/data/projects/{projectId}/table/{tableName}/columns` | List Columns |
| POST | `/data/projects/{projectId}/table/{tableName}/columns` | Add Column |
| PUT | `/data/projects/{projectId}/table/{tableName}/columns/{columnName}` | Update Column |
| DELETE | `/data/projects/{projectId}/table/{tableName}/columns/{columnName}` | Delete Column |
| POST | `/data/projects/{projectId}/table/{tableName}/import` | Import CSV |
| GET | `/data/projects/{projectId}/table/{tableName}/sample` | Get Sample CSV |
| GET | `/data/projects/{projectId}/queries` | List Queries |
| POST | `/data/projects/{projectId}/queries` | Create Query |
| POST | `/data/projects/{projectId}/queries/execute` | Execute Query |
| GET | `/data/projects/{projectId}/queries/{queryId}` | Read Query |

…and 77 more operations. They are listed in full on the page.

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/peaka/refs/heads/main/openapi/_original/peaka-api-openapi.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/peaka/refs/heads/main/json-schema/peaka-export-job-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/peaka/refs/heads/main/json-schema/peaka-query-execute-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/peaka/refs/heads/main/json-schema/peaka-connection-configuration-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/peaka/refs/heads/main/json-schema/peaka-table-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/peaka/refs/heads/main/json-schema/peaka-query-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/peaka/refs/heads/main/json-schema/peaka-export-request-schema.json

## Other Peaka APIs (1)

- [Peaka Gateway API](https://apis.io/apis/peaka/peaka-gateway-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/peaka/peaka-gateway-api-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/peaka/.