Peaka Gateway API

GET `/organizations`

List Organizations

Response

GET `/organizations/{organizationId}`

Read Organization

organizationId

ID of the Organization

Response

GET `/organizations/{organizationId}/workspaces`

List Workspaces

organizationId

ID of the Organization

Response

POST `/organizations/{organizationId}/workspaces`

Create Workspace

organizationId

Organization ID

Request Body

Create Workspace

Response

GET `/organizations/{organizationId}/workspaces/{workspaceId}`

Read Workspace

organizationId

Organization ID

workspaceId

Workspace ID

Response

PUT `/organizations/{organizationId}/workspaces/{workspaceId}`

Update Workspace

organizationId

Organization ID

workspaceId

Workspace ID

Request Body

Update Workspace

Response

DELETE `/organizations/{organizationId}/workspaces/{workspaceId}`

Delete Workspace

organizationId

Organization ID

workspaceId

Workspace ID

Response

GET `/organizations/{organizationId}/workspaces/{workspaceId}/projects`

List Projects

organizationId

ID of the Organization

workspaceId

ID of the Workspace

Response

POST `/organizations/{organizationId}/workspaces/{workspaceId}/projects`

Create Project

organizationId

ID of the Organization

workspaceId

ID of the Workspace

Request Body

Project to create

Response

GET `/organizations/{organizationId}/workspaces/{workspaceId}/projects/{projectId}`

Read Project

organizationId

ID of the Organization

workspaceId

ID of the Workspace

projectId

ID of the Project

Response

PUT `/organizations/{organizationId}/workspaces/{workspaceId}/projects/{projectId}`

Update Project

organizationId

ID of the Organization

workspaceId

ID of the Workspace

projectId

ID of the Project

Request Body

Project to update

Response

DELETE `/organizations/{organizationId}/workspaces/{workspaceId}/projects/{projectId}`

Delete Project

organizationId

ID of the Organization

workspaceId

ID of the Workspace

projectId

ID of the Project

Response

GET `/projects`

List Projects

Response

POST `/projects`

Create Project

Request Body

Project to create

Response

GET `/projects/{projectId}`

Read Project

projectId

ID of the Project

Response

PUT `/projects/{projectId}`

Update Project

projectId

ID of the Project

Request Body

Project to update

Response

DELETE `/projects/{projectId}`

Delete Project

projectId

ID of the Project

Response

GET `/projects/{projectId}/apiKeys`

List API Keys

projectId

Project ID

Response

POST `/projects/{projectId}/apiKeys`

Create API Key

projectId

Project ID

Request Body

API Key request

Response

DELETE `/projects/{projectId}/apiKeys/{apiKeyId}`

Delete API Key

projectId

Project ID

apiKeyId

API Key ID

Response

GET `/connections/config`

List Connection Config

Response

GET `/connections/config/{connectionType}`

Get Connection Config

connectionType

Type of connection

Response

GET `/connections/{projectId}`

List Connections

projectId

ID of the project

Response

POST `/connections/{projectId}`

Create Connection

projectId

ID of the project

Request Body

Connection Request

Response

POST `/connections/{projectId}/oauth2`

Oauth2 Callback

projectId

ID of the project

Request Body

Oauth2 Callback Body

Response

GET `/connections/{projectId}/{connectionId}`

Get Connection

projectId

ID of the project

connectionId

ID of the connection

Response

PUT `/connections/{projectId}/{connectionId}`

Update Connection

projectId

ID of the project

connectionId

ID of the connection

Request Body

Connection Request

Response

DELETE `/connections/{projectId}/{connectionId}`

Delete Connection

projectId

ID of the project

connectionId

ID of the connection

Response

GET `/connections/{projectId}/{connectionId}/detail`

Get Connection Detail

projectId

ID of the project

connectionId

ID of the connection

Response

GET `/data/projects/{projectId}/catalogs`

List Catalogs

projectId

ID of the project

Response

POST `/data/projects/{projectId}/catalogs`

Create Catalog

projectId

ID of the project

Request Body

Catalog Request

Response

GET `/data/projects/{projectId}/catalogs/{catalogId}`

Read Catalog

projectId

ID of the project

catalogId

ID of the catalog

Response

DELETE `/data/projects/{projectId}/catalogs/{catalogId}`

Delete Catalog

projectId

ID of the project

catalogId

ID of the catalog

Response

GET `/data/projects/{projectId}/catalogs/{catalogId}/schemas`

List Schemas

projectId

ID of the project

catalogId

ID of the catalog

Response

GET `/data/projects/{projectId}/catalogs/{catalogId}/schemas/{schemaName}/tables`

List Tables

projectId

ID of the project

catalogId

ID of the catalog

schemaName

Name of the schema

Response

GET `/data/projects/{projectId}/catalogs/{catalogId}/schemas/{schemaName}/tables/{tableName}/columns`

List Columns

projectId

ID of the project

catalogId

ID of the catalog

schemaName

Name of the schema

tableName

Name of the table

Response

GET `/data/projects/{projectId}/catalogs/{catalogId}/schemas/{schemaName}/tables/{tableName}/isCached`

Table is Cached

projectId

ID of the project

catalogId

ID of the catalog

schemaName

Name of the schema

tableName

Name of the table

Response

GET `/data/projects/{projectId}/catalogs/{catalogId}/schemas/{schemaName}/tables/{tableName}/statistics`

Table Statistics

projectId

ID of the project

catalogId

ID of the catalog

schemaName

Name of the schema

tableName

Name of the table

Response

POST `/data/projects/{projectId}/catalogs/{catalogId}/share`

Share Catalog

projectId

ID of the project

catalogId

ID of the catalog

Request Body

Share Request

Response

POST `/data/projects/{projectId}/search`

projectId

ID of the project

Request Body

Search Anywhere

Response

GET `/data/projects/{projectId}/bitable`

List BI Tables

projectId

ID of the Project

Response

POST `/data/projects/{projectId}/bitable/{tableName}`

Create BI Table

projectId

ID of the Project

tableName

Name of the BI table to create

Response

DELETE `/data/projects/{projectId}/bitable/{tableName}`

Delete BI Table

projectId

ID of the Project

tableName

Name of the BI table to delete

Response

GET `/data/projects/{projectId}/bitable/{tableName}/columns`

List BI Columns

projectId

ID of the Project

tableName

Name of the BI table

Response

POST `/data/projects/{projectId}/bitable/{tableName}/columns`

Add BI Column

projectId

ID of the Project

tableName

Name of the BI table

Request Body

Column Request

Response

PUT `/data/projects/{projectId}/bitable/{tableName}/columns/{columnName}`

Update BI Column

projectId

ID of the Project

tableName

Name of the BI table

columnName

Name of the column to update

Request Body

Response

DELETE `/data/projects/{projectId}/bitable/{tableName}/columns/{columnName}`

Delete BI Column

projectId

ID of the Project

tableName

Name of the BI table

columnName

Name of the column to delete

Response

GET `/data/projects/{projectId}/table`

List Tables

projectId

ID of the Project

Response

POST `/data/projects/{projectId}/table/{tableName}`

Create Table

projectId

ID of the Project

tableName

Name of the table to create

Response

DELETE `/data/projects/{projectId}/table/{tableName}`

Delete Table

projectId

ID of the Project

tableName

Name of the table to delete

Response

GET `/data/projects/{projectId}/table/{tableName}/columns`

List Columns

projectId

ID of the Project

tableName

Name of the table

Response

POST `/data/projects/{projectId}/table/{tableName}/columns`

Add Column

projectId

ID of the Project

tableName

Name of the table

Request Body

Column Request

Response

PUT `/data/projects/{projectId}/table/{tableName}/columns/{columnName}`

Update Column

projectId

ID of the Project

tableName

Name of the table

columnName

Name of the column to update

Request Body

Response

DELETE `/data/projects/{projectId}/table/{tableName}/columns/{columnName}`

Delete Column

projectId

ID of the Project

tableName

Name of the table

columnName

Name of the column to delete

Response

POST `/data/projects/{projectId}/table/{tableName}/import`

Import CSV

projectId

ID of the Project

tableName

Name of the table to import into

Response

GET `/data/projects/{projectId}/table/{tableName}/sample`

Get Sample CSV

projectId

ID of the Project

tableName

Name of the table

Response

GET `/data/projects/{projectId}/queries`

List Queries

projectId

ID of the Project

Response

POST `/data/projects/{projectId}/queries`

Create Query

projectId

ID of the Project

checkSchemaExists

Request Body

Query Request

Response

POST `/data/projects/{projectId}/queries/execute`

Execute Query

projectId

ID of the Project

format

Response format: CELL_TYPED (default), SIMPLE, or COMPACT

Request Body

Execute Query Request

Response

GET `/data/projects/{projectId}/queries/{queryId}`

Read Query

projectId

ID of the Project

queryId

ID of the Query

Response

PUT `/data/projects/{projectId}/queries/{queryId}`

Update Query

projectId

ID of the Project

queryId

ID of the Query

checkSchemaExists

Request Body

Query Request

Response

DELETE `/data/projects/{projectId}/queries/{queryId}`

Delete Query

projectId

ID of the Project

queryId

ID of the Query

Response

GET `/data/projects/{projectId}/queries/folders`

List Query Folders

projectId

ID of the Project

Response

POST `/data/projects/{projectId}/queries/folders`

Create Query Folder

projectId

ID of the Project

Request Body

Folder creation request

Response

GET `/data/projects/{projectId}/queries/folders/tree`

Get Query Folder Tree

projectId

ID of the Project

Whether to include queries within each folder node

includeQueries

rootFolderId

ID of the root folder to start the subtree from

Response

GET `/data/projects/{projectId}/queries/folders/{folderId}`

Read Query Folder

projectId

ID of the Project

folderId

ID of the Query Folder

Response

PUT `/data/projects/{projectId}/queries/folders/{folderId}`

Add/Remove Queries In/From Folder

projectId

ID of the Project

folderId

ID of the Query Folder

Request Body

Query add/remove request

Response

DELETE `/data/projects/{projectId}/queries/folders/{folderId}`

Delete Query Folder

projectId

ID of the Project

folderId

ID of the Query Folder

If true, recursively deletes the folder along with all sub-folders and queries

force

Response

POST `/data/projects/{projectId}/queries/folders/{parentFolderId}`

Create Query Folder Under Parent

projectId

ID of the Project

parentFolderId

ID of the parent Query Folder

Request Body

Folder creation request

Response

POST `/data/projects/{projectId}/semantic-catalogs`

Create a semantic catalog

projectId

ID of the Project

Request Body

Semantic Catalog Request

Response

POST `/data/projects/{projectId}/semantic-catalogs/{catalogId}`

Create a semantic table

projectId

ID of the Project

catalogId

ID of the Semantic Catalog

Request Body

Semantic Table Request

Response

POST `/data/projects/{projectId}/semantic-catalogs/{catalogId}/share`

Share Semantic Catalog

projectId

ID of the Project

catalogId

ID of the Semantic Catalog to share

Request Body

Share Request

Response

DELETE `/data/projects/{projectId}/semantic-catalogs/{catalogId}/table/{tableId}`

Delete a semantic table

projectId

ID of the Project

catalogId

ID of the Semantic Catalog

tableId

ID of the Semantic Table

Response

POST `/data/projects/{projectId}/cache`

Create Cache

projectId

The unique identifier of the project that owns the data source

Request Body

Cache creation request specifying the target table and optional sync schedules

Response

POST `/data/projects/{projectId}/cache/batch`

Create Batch Cache

projectId

The unique identifier of the project that owns the data sources

Request Body

Array of cache creation requests. Each element specifies a table to cache with optional sync schedules.

Response

GET `/data/projects/{projectId}/cache/status`

Get All Cache Statuses of a Project

projectId

The unique identifier of the project to list cache statuses for

Response

GET `/data/projects/{projectId}/cache/{cacheId}`

Get Cache Settings

projectId

The unique identifier of the project that owns the cache

cacheId

The unique identifier of the cache to retrieve (UUID format)

Response

PUT `/data/projects/{projectId}/cache/{cacheId}`

Update Cache Settings

projectId

The unique identifier of the project that owns the cache

cacheId

The unique identifier of the cache to update (UUID format)

Request Body

Updated schedule configuration. Only the provided schedule fields are updated.

Response

DELETE `/data/projects/{projectId}/cache/{cacheId}`

Delete Cache

projectId

The unique identifier of the project that owns the cache

cacheId

The unique identifier of the cache to delete (UUID format)

Response

POST `/data/projects/{projectId}/cache/{cacheId}/cancelFullRefreshUpdate`

Cancel Running Full Refresh

projectId

The unique identifier of the project that owns the cache

cacheId

The unique identifier of the cache whose full refresh should be cancelled (UUID format)

Response

POST `/data/projects/{projectId}/cache/{cacheId}/cancelIncrementalUpdate`

Cancel Running Incremental Update

projectId

The unique identifier of the project that owns the cache

cacheId

The unique identifier of the cache whose incremental sync should be cancelled (UUID format)

Response

GET `/data/projects/{projectId}/cache/{cacheId}/executionHistory`

Get Cache Execution History

projectId

The unique identifier of the project that owns the cache

cacheId

The unique identifier of the cache whose history is requested (UUID format)

limit

Maximum number of execution records to return. Defaults to 10.

offset

Number of records to skip from the start of the result set, used for pagination. Defaults to 0.

Response

POST `/data/projects/{projectId}/cache/{cacheId}/fullRefreshUpdate`

Trigger Full Refresh Cache Update

projectId

The unique identifier of the project that owns the cache

cacheId

The unique identifier of the cache to fully refresh (UUID format)

Response

POST `/data/projects/{projectId}/cache/{cacheId}/incrementalUpdate`

Trigger Incremental Cache Update

projectId

The unique identifier of the project that owns the cache

cacheId

The unique identifier of the cache to sync (UUID format)

Response

GET `/data/projects/{projectId}/cache/{cacheId}/status`

Get Cache Status

projectId

The unique identifier of the project that owns the cache

cacheId

The unique identifier of the cache to check (UUID format)

When true, omits the cacheActionLogs array from the response for a lighter payload. Defaults to false.

excludeLogs

Response

GET `/data/projects/{projectId}/catalog/{catalogId}/cache/status`

Get All Cache Statuses of a Catalog

projectId

The unique identifier of the project that owns the catalog

catalogId

The unique identifier of the catalog (data source connection) to filter caches by

Response

GET `/data/projects/{projectId}/catalog/{catalogId}/schema/{schemaName}/cache/status`

Get All Cache Statuses of a Schema

projectId

The unique identifier of the project that owns the catalog

catalogId

The unique identifier of the catalog (data source connection) that owns the schema

schemaName

The name of the schema to filter caches by

Response

POST `/data/projects/{projectId}/queries/{queryId}/exports`

Export Query (async)

projectId

ID of the Project

queryId

ID of the Query

Request Body

Export options

Response

POST `/data/projects/{projectId}/catalogs/{catalogId}/schemas/{schemaName}/tables/{tableName}/exports`

Export Table (async)

projectId

ID of the Project

catalogId

ID of the Catalog

schemaName

Schema name

tableName

Table name

Request Body

Export options

Response

GET `/data/projects/{projectId}/exports`

List Exports

projectId

ID of the Project

status

Comma-separated status filter: PENDING,RUNNING,SUCCEEDED,FAILED,CANCELLED. Examples: SUCCEEDED,RUNNING (active or done), FAILED,CANCELLED (unsuccessful), SUCCEEDED (single status). Omit to return every status.

limit

Page size, clamped to [1, 200]

createdBefore

Keyset cursor (ISO-8601): the previous page's last createdAt. Example: 2026-06-10T15:23:26.893985Z. Omit for the first page.

Response

GET `/data/projects/{projectId}/exports/{exportId}`

Read Export

projectId

ID of the Project

exportId

Export job id (UUID)

Response

DELETE `/data/projects/{projectId}/exports/{exportId}`

Cancel Export

projectId

ID of the Project

exportId

Export job id (UUID)

Response

GET `/data/projects/{projectId}/catalogs/{catalogId}/parametricTables`

List Parametric Tables

projectId

ID of the project

catalogId

ID of the catalog

Response

POST `/data/projects/{projectId}/catalogs/{catalogId}/parametricTables`

Create Parametric Table

projectId

ID of the project

catalogId

ID of the catalog

Request Body

Parametric Table definition

Response

DELETE `/data/projects/{projectId}/catalogs/{catalogId}/parametricTables`

Delete Parametric Table

projectId

ID of the project

catalogId

ID of the catalog

toSchema

Target schema of the parametric table

toTable

Target table name of the parametric table

Response

GET `/ui/initSession`

Init Session (Deprecated)

projectId

ID of the Project

timeoutInSeconds

Session timeout in seconds

theme

Theme for the embedded UI (e.g., dark, light)

Whether to override the default theme

themeOverride

Response

POST `/ui/initSession`

Init Session

Request Body

Session Initialization Request

Response

GET `/supportedDrivers`

List Supported Drivers

catalogName

Catalog name.

Drivers such as sql_alchemy supports only one catalog at a time. So specific catalog name must be provided in order to use.

Response

GET `/supportedDrivers/jdbc`

Get JDBC Driver

Response

GET `/supportedDrivers/sql_alchemy`

Get SQL Alchemy Driver

catalogName

Catalog name.

Drivers such as sql_alchemy supports only one catalog at a time. So specific catalog name must be provided in order to use.

Response

GET `/metadata/{projectId}`

Get Project Metadata

projectId

catalogId

schemaName

Response

PUT `/metadata/{projectId}/categorical/{catalogId}/{schemaName}/{tableName}/{columnName}`

Generate categorical values from the column.

projectId

catalogId

schemaName

tableName

columnName

Request Body

Response

DELETE `/metadata/{projectId}/categorical/{catalogId}/{schemaName}/{tableName}/{columnName}`

Delete categorical values from the column meta and remove the scheduled job

projectId

catalogId

schemaName

tableName

columnName

Response

GET `/metadata/{projectId}/golden-sql/query`

Semantic query golden sqls for the project.

projectId

Response

GET `/metadata/{projectId}/golden-sqls`

List of golden sqls for the project.

projectId

Response

POST `/metadata/{projectId}/golden-sqls`

Create golden sql for the project

projectId

Request Body

Response

DELETE `/metadata/{projectId}/golden-sqls/{id}`

Delete golden sql from the project.

projectId

Response

GET `/metadata/{projectId}/query`

Semantic query metadata for the project.

table

topK

projectId

Response

GET `/metadata/{projectId}/questions/generate`

Generate sample ai questions for the project

projectId

question

Response

POST `/metadata/{projectId}/refresh`

Refresh Project Metadata

projectId

Request Body

Response

GET `/metadata/{projectId}/refresh/callback`

Get Metadata Refresh Job Callback

projectId

Response

POST `/metadata/{projectId}/refresh/callback`

projectId

Request Body

Response

DELETE `/metadata/{projectId}/refresh/callback`

Unregister Metadata Refresh Job Callback

projectId

Response

GET `/metadata/{projectId}/refresh/{catalogId}`

Get Metadata Refresh Job Status

projectId

catalogId

Response

GET `/metadata/{projectId}/relations/{catalogId}`

Get Project Catalog Metadata Relations

projectId

catalogId

Response

POST `/metadata/{projectId}/relations/{catalogId}/{schemaName}/{tableName}/{columnName}`

Add Relation To Metadata

projectId

catalogId

schemaName

tableName

columnName

Request Body

Response

PUT `/metadata/{projectId}/relations/{catalogId}/{schemaName}/{tableName}/{relationId}`

Update Relation From Metadata

projectId

catalogId

schemaName

tableName

relationId

Request Body

Response

DELETE `/metadata/{projectId}/relations/{catalogId}/{schemaName}/{tableName}/{relationId}`

Delete Relation From Metadata

projectId

catalogId

schemaName

tableName

relationId

Response

POST `/metadata/{projectId}/semantics/{catalogId}/{schemaName}/{tableName}`

Generate semantics for the table

projectId

catalogId

schemaName

tableName

Request Body

Response

PUT `/metadata/{projectId}/{catalogId}`

Update Metadata ai usage per catalog level

projectId

catalogId

Request Body

Response

PUT `/metadata/{projectId}/{catalogId}/{schemaName}`

Update Metadata ai usage per schema level

projectId

catalogId

schemaName

Request Body

Response

PUT `/metadata/{projectId}/{catalogId}/{schemaName}/{tableName}`

Update Metadata

projectId

catalogId

schemaName

tableName

Request Body

Response

GET `/ai-agent/workflow/png`

Get png image of current ai workflow

Response

POST `/ai-agent/{projectId}/chat`

Chat with agent

projectId

Request Body

Response

POST `/ai-agent/{projectId}/chat/stream`

Chat with agent via stream

projectId

Request Body

Response

GET `/ai-agent/{projectId}/threads`

List ai-agent threads

projectId

Response

GET `/ai-agent/{projectId}/threads/{threadId}`

Get ai-agent thread

projectId

threadId

Response

PUT `/ai-agent/{projectId}/threads/{threadId}`

Update ai-agent thread display name

projectId

threadId

Request Body

Response

DELETE `/ai-agent/{projectId}/threads/{threadId}`

Delete ai-agent thread

projectId

threadId

Response

POST `/sql/transpile/{dialect}`

Transpile SQL

dialect

Target SQL dialect to transpile into

Request Body

SQL query to transpile

Response

GET `/data/projects/{projectId}/materialized-queries/status`

List Materialized Query Statuses

projectId

ID of the Project

Response

POST `/data/projects/{projectId}/materialized-queries/{queryId}/cancel`

Cancel Materialized Query Refresh

projectId

ID of the Project

queryId

ID of the Query

Response

POST `/data/projects/{projectId}/materialized-queries/{queryId}/refresh`

Refresh Materialized Query

projectId

ID of the Project

queryId

ID of the Query

Response

GET `/data/projects/{projectId}/materialized-queries/{queryId}/status`

Read Materialized Query Status

projectId

ID of the Project

queryId

ID of the Query

Response