🧩 Business User

🛠 Developer or Integrator

What type of user are you?

Need Help?

Welcome to Peaka Documentation

Peaka

Get started with Project Operations: Learn how you can start a new project in Peaka.

How to create a project

Get started with Project Operations: Learn how you can clone an existing project in Peaka.

How to clone a project in Peaka

Get started with Project Operations: Learn how you can delete a project in Peaka.

How to delete a project in Peaka

Get started with Project Operations: Learn how you can change the name of your Peaka project.

How to rename a project in Peaka

Get started with Project Operations: Learn how you can share a read-only copy of your project in Peaka.

How to send a copy of a project to another user

Get started with Project Operations: Learn how you can collaborate by sharing your Peaka project.

How to share a project with another user

Learn about Peaka Queries and how you can harness their power

What is a Peaka Query?

Learn about Peaka Tables and how you can use them to manage your data

What is a Peaka Table?

Learn about Peaka Big Table and how you can use it to manage your data

What is a Peaka Big Table?

Learn about the differences between Peaka Table and Peaka Big Table

Differences of Peaka Table and Peaka Big Table

Learn how you can create your first query in Peaka

Creating a Peaka Query

Learn how you can create your first internal table in Peaka

Creating a Peaka Table

Learn how you can connect your data using a SaaS connector

Connecting data using a SaaS connector

Learn about 3 basic concepts for organizing your data in Peaka

What are catalogs, schemas, and virtual tables?

CDC - PostgreSQL Setup Documentation

CDC - MySQL Setup Documentation

CDC - MongoDB Setup Documentation

CDC - MariaDB Setup Documentation

CDC - Oracle Setup Documentation

Introduction

Servers

Authentication

Understanding the core components and their relationships in the Peaka API ecosystem.

Structure

Retrieves all the organizations accessible by the authenticated user.

An Organization is the highest-level resource that can contain multiple Workspaces.


List Organizations

Returns the specified Organization.

An Organization is the highest-level resource that can contain multiple Workspaces.


Read Organization

Returns all workspaces under the specified Organization.

A Workspace is a collaborative environment within an Organization that groups Projects together. It facilitates team collaboration, resource management, and organization of data operations.

The hierarchical structure in Peaka is:

<code>Organization (top-level) → Workspace → Project</code>

Projects contain data catalogs and workflows that teams manage within a Workspace.


List Workspaces

The endpoint allows you to create a new Workspace within an Organization.

A Workspace is a collaborative environment within an Organization that groups Projects together. It facilitates team collaboration, resource management, and organization of data operations.

The hierarchical structure in Peaka is:

<code>Organization (top-level) → Workspace → Project</code>

Projects contain data catalogs and workflows that teams manage within a Workspace.


Create Workspace

Returns details of a specified Workspace, which is a collaborative environment within an Organization that groups Projects together.

A Workspace facilitates team collaboration, resource management, and organization of data operations.

The hierarchical structure in Peaka is:

<code>Organization (top-level) → Workspace → Project</code>

Projects contain data catalogs and workflows that teams manage within a Workspace.


Read Workspace

Updates the specified Workspace within an Organization.

A Workspace is a collaborative environment within an Organization that groups Projects together, facilitating team collaboration and resource management.

The hierarchical structure in Peaka is:

<code>Organization (top-level) → Workspace → Project</code>

Projects contain data catalogs and workflows that teams manage within a Workspace.


Update Workspace

Deletes a specified Workspace within an Organization.

A Workspace is a collaborative environment that groups Projects to facilitate team collaboration and resource management.

The hierarchical structure in Peaka is:

<code>Organization (top-level) → Workspace → Project</code>


Delete Workspace

Fetches all projects within the given Workspace.

A unit of work where queries, data tables, and semantic catalogs are managed. Projects live inside workspaces.


List Projects

Create Project

Read Project

Update Project

Delete Project

List API Keys

Create API Key

Delete API Key

List all connection configurations.
This will return a list of all connection configurations available in the system.

List Connection Config

Get Connection Config

List Connections

This endpoint allows you to create a new connection for a specified project.

You need to provide the project ID and the connection details in the request body.

The connection details include the name, type, and credentials required for the connection.

Depending on the connection type, additional parameters may be required under credentials.

You can view the list of supported connection types by calling the /connections/config endpoint.

You can switch examples from the second dropdown of the sample request component. (cURL (first dropdown) - Stripe Connection Request (second dropdown))

**Note**: Typically, the connection creation process involves the following steps:
1. First, learn about the connection type and the required parameters by calling the /connections/config endpoint.
2. Create a connection request with the required parameters.
3. If the connection requires Oauth2 authorization, there may be additional steps to follow. See https://docs.peaka.com/how-to-guides/how-to-create-oauth2-based-connections-via-peaka for more information.

**Example**:
- POSTGRES Connection Configuration:

GET /connections/config endpoint displays all of the connection types.

GET /connection/config/POSTGRES endpoint displays the POSTGRES connection configuration.

The definition of the POSTGRES connection configuration is as follows:
``` json
    {
        "connectionType": "POSTGRES",
        "connectionTypeLabel": "PostgreSQL",
        "name": "PostgreSQL",
        "authorizationType": "custom",
        "credentialSchemaType": "postgres_credential_schema",
        "category": "Database",
        "configuration": [
            {
                "fieldName": "url",
                "fieldType": "text",
                "required": true,
                "description": "URL"
            },
            {
                "fieldName": "port",
                "fieldType": "number",
                "required": true,
                "description": "Port"
            },
            {
                "fieldName": "user",
                "fieldType": "text",
                "required": true,
                "description": "User"
            },
            {
                "fieldName": "password",
                "fieldType": "text",
                "required": true,
                "description": "Password"
            },
            {
                "fieldName": "databaseName",
                "fieldType": "text",
                "required": true,
                "description": "Database Name"
            },
            {
                "fieldName": "useSsl",
                "fieldType": "boolean",
                "required": true,
                "description": "Use SSL"
            }
        ],
        "documentationUrl": "https://docs.peaka.com/integrations/postgresql"
    }
```

According to the POSTGRES connection configuration, the connection request should include the following parameters (respecting to the required flag):
- url: URL of the host IP or domain
- port: Port number
- user: User of the database
- password: Password of the user
- databaseName: Name of the database
- useSsl: Boolean value to indicate whether to use SSL

``` json
{
    "name": "examplePostgre",
    "type": "POSTGRES",
    "credential": {
        "url": "<host ip or domain>",
        "port": 5432,
        "user": "userOfYourDB",
        "password": "passwordOfUser",
        "databaseName": "yourDBName",
        "useSsl": false
    }
}
```



Create Connection

This callback/webhook is used while creating a new connection with Oauth2. See https://docs.peaka.com/how-to-guides/how-to-create-oauth2-based-connections-via-peaka for more information.

Oauth2 Callback

Get Connection

Update Connection

Delete Connection

Get connection detail by ID. Returns only non-sensitive information.

Get Connection Detail

List Catalogs

Create Catalog

Read Catalog

Delete Catalog

List Schemas

List Tables

List Columns

Table is Cached

Table Statistics

See Data -- Catalog / List Tables for more details.

List BI Tables

Create BI Table

Delete BI Table

See Data -- Catalog / List Columns for more details.

List BI Columns

Add BI Column

Update BI Column

Delete BI Column

Create Table

Delete Table

Add Column

Update Column

Delete Column

Import CSV

Get Sample CSV

List Queries

Create Query

Execute Query

Read Query

Update Query

Delete Query

Create a semantic catalog

Create a semantic table

Share a semantic table

Delete a semantic table

Create Cache

Create Batch Cache

Get All Cache Statuses of a Project

Update Cache Settings

Delete Cache

Full Refresh Cache

Update Cache Incrementally

Get Cache Status

Get All Cache Statuses of a Catalog

List Parametric Tables

Create Parametric Table

Delete Parametric Table

Init Session (Deprecated)

Init Session

List Supported Drivers

Get JDBC Driver

Get SQL Alchemy Driver

Get Project Metadata

Generate categorical values from the column.

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

Semantic query golden sqls for the project.

List of golden sqls for the project.

Create golden sql for the project

Delete golden sql from the project.

Semantic query metadata for the project.

Generate sample ai questions for the project

Refresh Project Metadata

Get Project Catalog Metadata Relations

Add Relation To Metadata

Update Relation From Metadata

Delete Relation From Metadata

Generate semantics for the table

Update Metadata ai usage per catalog level

Update Metadata ai usage per schema level

Update Metadata

Ask Question To AI Agent

Get AI Chat History

Update AI Chat History Thread Name

Delete AI Chat History

Get png image of current ai workflow

Chat with agent

Chat with agent via stream

List ai-agent threads

Get ai-agent thread

Update ai-agent thread display name

Delete ai-agent thread

Transpile a sql query into given dialect

What is Embedded Peaka?

Peaka as a Data Source

Peaka as a Data Management Backend

Peaka as a Data Management Tool with UI

Introduction to how to use SQL with Peaka.

DESCRIBE

EXECUTE

PREPARE

SELECT

SHOW CATALOGS

SHOW COLUMNS

SHOW SCHEMAS

VALUES

Data types

Aggregate functions

Array functions and operators

Binary functions and operators

Bitwise functions

Comparison functions and operators

Conditional Expressions

Date and time functions and operators

Decimal functions and operators

HyperLogLog Functions

JSON functions and operators

Lambda expressions

Machine learning functions

Quantile digest functions

Set Digest functions

String functions and operators

Table functions

Teradata functions

URL functions

UUID Functions

Window functions

Introduction to SQL routines

Example SQL routines

BEGIN

CASE

DECLARE

Get Started

Project Operations

Connecting Your Data

CDC Setup

Welcome to Peaka Documentation

What type of user are you?

🧩 Business User

Integrations

BI Tools

🛠 Developer or Integrator

API Reference

Embedded Peaka

Need Help?

Get Started

Project Operations

Connecting Your Data

CDC Setup

​What type of user are you?

​🧩 Business User

Integrations

BI Tools

​🛠 Developer or Integrator

API Reference

Embedded Peaka

​Need Help?

What type of user are you?

🧩 Business User

🛠 Developer or Integrator

Need Help?