---
canonical_url: "https://docs.composio.dev/toolkits/peaka"
markdown_url: "https://docs.composio.dev/toolkits/peaka.md"
product: "platform"
version: null
last_updated: null
---

# Peaka

Peaka is a data integration and AI platform for managing organizations, projects, data connections, catalogs, queries, metadata, and analytics workflows.

- **Category:** databases
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 9
- **Triggers:** 0
- **Slug:** `PEAKA`
- **Version:** 00000000_00

## Tools

### Create Project

**Slug:** `PEAKA_CREATE_PROJECT`

Create a project in a Peaka workspace and return its project ID and available project details for use with Peaka data and query tools.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name for the new project. |
| `description` | string | No | Optional description of the project's purpose. |
| `workspace_id` | string | Yes | ID of the workspace that will contain the project. |
| `organization_id` | string | Yes | ID of the organization containing the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Workspace

**Slug:** `PEAKA_CREATE_WORKSPACE`

Create a workspace in an organization and return its workspace ID and details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name for the new workspace. |
| `description` | string | No | Optional description of the workspace's purpose. |
| `organization_id` | string | Yes | ID of the organization that will contain the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Project

**Slug:** `PEAKA_DELETE_PROJECT`

Permanently delete a project and its project-scoped data from a Peaka workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | Opaque ID of the project to permanently delete. |
| `workspace_id` | string | Yes | ID of the workspace containing the project. |
| `organization_id` | string | Yes | ID of the organization containing the project. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Workspace

**Slug:** `PEAKA_DELETE_WORKSPACE`

Permanently delete a workspace. Projects and other contents within it may become unavailable.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | ID of the workspace to permanently delete. |
| `organization_id` | string | Yes | ID of the organization containing the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Execute Query

**Slug:** `PEAKA_EXECUTE_QUERY`

Execute one read-only SQL SELECT or CTE ending in LIMIT 1-1000 in a Peaka project and return rows in SIMPLE object format.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sql` | string | Yes | One read-only SQL statement beginning with SELECT or WITH and ending with LIMIT 1-1000. Qualify Peaka resources as catalog.schema.table. |
| `project_id` | string | Yes | ID of the project against which to execute the query. |
| `timeout_seconds` | integer | No | Optional provider-side query timeout in seconds. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Data Resources

**Slug:** `PEAKA_LIST_DATA_RESOURCES`

Browse a project's catalogs, schemas, tables, or columns to discover qualified resources for SQL queries.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `catalog_id` | string | No | Catalog ID; required for schemas, tables, and columns. |
| `project_id` | string | Yes | ID of the project whose data resources to browse. |
| `table_name` | string | No | Table name; required for columns. |
| `schema_name` | string | No | Schema name; required for tables and columns. |
| `resource_type` | string ("catalogs" | "schemas" | "tables" | "columns") | Yes | Resource level to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Hierarchy

**Slug:** `PEAKA_LIST_HIERARCHY`

List organizations, workspaces in an organization, or projects in a workspace, returning the IDs needed for hierarchy administration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `level` | string ("organizations" | "workspaces" | "projects") | Yes | Hierarchy level to list. |
| `workspace_id` | string | No | Workspace ID; required when listing projects. |
| `organization_id` | string | No | Organization ID; required when listing workspaces or projects. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Project

**Slug:** `PEAKA_UPDATE_PROJECT`

Replace the name and optional description of a project in its current workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Complete replacement name for the project. |
| `project_id` | string | Yes | Opaque project ID returned by create or list operations. |
| `description` | string | No | Complete replacement description; omit to leave it absent. |
| `workspace_id` | string | Yes | ID of the workspace containing the project. |
| `organization_id` | string | Yes | ID of the organization containing the project. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Workspace

**Slug:** `PEAKA_UPDATE_WORKSPACE`

Replace the name and optional description of an existing workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Complete replacement name for the workspace. |
| `description` | string | No | Complete replacement description; omit to leave it absent. |
| `workspace_id` | string | Yes | ID of the workspace to update. |
| `organization_id` | string | Yes | ID of the organization containing the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |