# Kaleido

Kaleido is a full-stack platform for building and managing enterprise blockchain networks and applications.

- **Category:** developer tools
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 29
- **Triggers:** 0
- **Slug:** `KALEIDO`
- **Version:** 20260312_00

## Tools

### Add Organization Identity Proof

**Slug:** `KALEIDO_ADD_IDENTITY_PROOF`

Add an x509 identity proof to a Kaleido organization. Use this to register a certificate chain that links an organization's off-chain PKI identity to their blockchain accounts. The certificate will be in 'pending' state until verified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | A human-readable name for the identity proof, typically describing the certificate purpose (e.g., 'Root CA', 'Production Certificate') |
| `type` | string | No | Type of the identity proof. Currently only 'x509' certificates are supported. Defaults to 'x509'. |
| `org_id` | string | Yes | The Kaleido organization ID (e.g., 'u0cvzlsyw4'). Obtain this from the get_organizations action. |
| `payload` | string | Yes | The Base64-encoded x509 certificate chain. This should be a valid PEM certificate converted to Base64 format. |

#### 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 API Key

**Slug:** `KALEIDO_CREATE_API_KEY`

Creates a new API key for the specified Kaleido organization. The returned apikey secret should be stored securely as it cannot be retrieved again. Use KALEIDO_GET_ORGANIZATIONS to obtain a valid org_id first. Note: Organizations have a limit on active API keys (e.g., 5 for starter plans).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Optional human-readable name for the API key to help identify its purpose |
| `org_id` | string | Yes | The organization ID to create the API key for. Obtain this from the Get Organizations action |

#### 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 API Key

**Slug:** `KALEIDO_DELETE_API_KEY`

Permanently deletes an API key by its ID. First use 'Get API Keys' to retrieve the list of API keys and their IDs. The deletion is irreversible.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `apikey_id` | string | Yes | The unique identifier of the API key to delete. You can find API key IDs by using the 'Get API Keys' action which returns a list of keys with their '_id' field. |

#### 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 Organization Identity Proof

**Slug:** `KALEIDO_DELETE_ORGANIZATION_IDENTITY_PROOF`

Remove an x509 identity proof from a Kaleido organization. This permanently deletes the identity proof. The deletion is irreversible.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | The Kaleido organization ID (e.g., 'u0cvzlsyw4'). Obtain this from the get_organizations action. |
| `proof_id` | string | Yes | The unique identifier of the identity proof to delete. You can find proof IDs by listing identity proofs for an organization. |

#### 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 |

### Get API Key

**Slug:** `KALEIDO_GET_API_KEY`

Tool to retrieve details of a specific API key by its ID. Use when you need to get information about a particular API key after obtaining its ID from the Get API Keys action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `apikey_id` | string | Yes | The unique identifier of the API key to retrieve. You can find API key IDs by using the 'Get API Keys' action which returns a list of keys with their '_id' field. |

#### 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 |

### Get API Keys

**Slug:** `KALEIDO_GET_API_KEYS`

Tool to retrieve all API keys associated with the organization. Use when you need an overview of existing API keys after authenticating.

#### 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 |

### Get Application Credentials

**Slug:** `KALEIDO_GET_APPLICATION_CREDENTIALS`

Tool to retrieve application credentials for a specific environment. Use when you need to list DApp credentials after environment setup.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `consortia_id` | string | Yes | ID of the consortium |
| `environment_id` | string | Yes | ID of the environment |

#### 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 |

### Get Billing Summary

**Slug:** `KALEIDO_GET_BILLING_SUMMARY`

Retrieves a summary of billing data for the specified organization for the current month. Use this to view costs breakdown by memberships, nodes, services, storage, and support.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | string | No | The year (e.g., 2024, 2025). Defaults to current year if not specified. |
| `month` | string | No | The month name (e.g., january, february, etc.). Defaults to current month if not specified. |
| `org_id` | string | Yes | Organization identifier |

#### 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 |

### Get Consortia

**Slug:** `KALEIDO_GET_CONSORTIA`

Tool to retrieve all consortia associated with the organization. Use after authenticating to view existing consortia.

#### 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 |

### Get Event Streams

**Slug:** `KALEIDO_GET_EVENT_STREAMS`

List all event streams configured on a Kaleido blockchain node's Ethconnect REST API Gateway. Event streams provide at-least-once delivery of Ethereum events from your blockchain node to webhook endpoints or WebSocket connections. Use this tool to retrieve the current event stream configurations. Note: Requires environment_id, node_id, and zone_domain to construct the Ethconnect URL, or a full_url override. Without these, falls back to the console API which may not return event streams data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `node_id` | string | No | Kaleido node ID exposing Ethconnect (used for URL composition) |
| `full_url` | string | No | Override base URL completely. If this already includes /eventstreams it will be used as-is. |
| `zone_domain` | string | No | Zone domain used to reach the Ethconnect gateway (e.g., us-east-1.connect.kaleido.io) |
| `environment_id` | string | No | Kaleido environment ID (used for Ethconnect URL composition) |

#### 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 |

### Get Organization Identity Proof

**Slug:** `KALEIDO_GET_IDENTITY_PROOF`

Tool to retrieve a specific identity proof for a Kaleido organization. Use when you need details about a specific x509 certificate or identity proof that was previously added to an organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | The Kaleido organization ID (e.g., 'u0cvzlsyw4'). Obtain this from the get_organizations action. |
| `proof_id` | string | Yes | The unique identifier of the identity proof to retrieve (e.g., 'u0wpjdqkha'). |

#### 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 |

### Get Invitations

**Slug:** `KALEIDO_GET_INVITATIONS`

Tool to retrieve all invitations for the current user where they are the target. Use after authenticating to view pending invitations.

#### 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 |

### Get Memberships

**Slug:** `KALEIDO_GET_MEMBERSHIPS`

Tool to retrieve all memberships for the current user. Use after authenticating to list user memberships.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | Optional Mongo-style query string to filter memberships |

#### 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 |

### Get Organization

**Slug:** `KALEIDO_GET_ORGANIZATION`

Tool to retrieve details of a specific Kaleido organization by its ID. Use when you need to fetch information about a particular organization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | Unique organization identifier |

#### 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 |

### Get Organization Plan

**Slug:** `KALEIDO_GET_ORGANIZATION_PLAN`

Retrieve the subscription plan details for a Kaleido organization. Returns plan name, waitlist status, and resource limits including allowed providers, nodes, services, configurations, and features. Use GET_ORGANIZATIONS first to obtain valid org_id values.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | The unique Kaleido organization ID (e.g., 'u0cvzlsyw4'). Obtain this from the GET_ORGANIZATIONS action. |

#### 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 |

### Get Organizations

**Slug:** `KALEIDO_GET_ORGANIZATIONS`

Retrieves all organizations that the authenticated user has access to in Kaleido. Returns organization details including: - Organization ID, name, and type - Subscription plan and billing information - Plan limits (allowed providers, nodes, services, etc.) - Creation and update timestamps Use this action to discover available organizations before performing other organization-specific operations like listing consortia, memberships, or services.

#### 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 |

### Get Organization Billing Provider

**Slug:** `KALEIDO_GET_ORG_BILLING_PROVIDER`

Retrieves billing provider information for a specific organization in Kaleido. Returns the type of billing provider (AWS, Stripe, or other) and includes detailed payment information if the organization uses Stripe billing (card details, billing address).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | Unique organization identifier |

#### 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 |

### Get Plans

**Slug:** `KALEIDO_GET_PLANS`

Retrieve all available Kaleido subscription plans. Returns plan details including enabled status, tier level, and resource limits. Use this to discover available plans before creating or upgrading environments.

#### 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 |

### Get Regions

**Slug:** `KALEIDO_GET_REGIONS`

Retrieve all available Kaleido deployment regions and their deployment zones. Returns a dictionary of regions (keyed by region code like 'u0', 'e0', 'a0', 'k0', 'u1', 'e1') with each region containing its API console host URL and available deployment zones. Use this action to discover which geographic regions are available for deploying blockchain environments and whether they are currently accepting new deployments.

#### 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 |

### Get Releases

**Slug:** `KALEIDO_GET_RELEASES`

Retrieve all available blockchain node software releases from the Kaleido platform. Use this tool to: - List all runtime releases available for different blockchain providers (quorum, geth, besu, corda, fabric) - Check version information and release statuses (ga, beta, interim, deprecated) - Find container image tags associated with each release - Understand upgrade prerequisites via prereq_eips and optional_eips fields Returns a list of releases sorted by creation date, including current and historical versions. No input parameters are required.

#### 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 |

### Get Role By ID

**Slug:** `KALEIDO_GET_ROLE_BY_ID`

Retrieve a specific user role assignment within a Kaleido organization. Returns detailed information about the role including user ID, email, role name (e.g., 'admin'), and associated metadata. Use GET_ORGANIZATIONS to obtain org_id and GET_ROLES to obtain role_id values.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | The unique Kaleido organization ID (e.g., 'u0cvzlsyw4'). Obtain this from the GET_ORGANIZATIONS action. |
| `role_id` | string | Yes | The unique role assignment ID (e.g., 'u0xvg2zbom'). Obtain this from the GET_ROLES action. |

#### 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 |

### Get Roles

**Slug:** `KALEIDO_GET_ROLES`

Retrieve all user role assignments for a Kaleido organization. Returns each user's role (e.g., 'admin'), email, and associated metadata. Use GET_ORGANIZATIONS first to obtain valid org_id values.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `org_id` | string | Yes | The unique Kaleido organization ID (e.g., 'u0cvzlsyw4'). Obtain this from the GET_ORGANIZATIONS action. |

#### 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 |

### Get Services

**Slug:** `KALEIDO_GET_SERVICES`

Tool to retrieve all services the current user owns or can see. Use after authenticating to list available services.

#### 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 |

### Get Token Factory Tokens

**Slug:** `KALEIDO_GET_TOKEN_FACTORY_TOKENS`

Retrieves all token contracts from a Kaleido Token Factory service. The Token Factory service enables deployment of ERC20 (fungible) and ERC721 (non-fungible) token contracts. This action lists all token contracts created through the service. Prerequisites: - A Token Factory service must be provisioned in your Kaleido environment - Obtain the service URL from GET /services action (look for 'tokenfactory' service type) Returns token contract details including: - Token name, symbol, and type (ERC20/ERC721) - Contract deployment status and address - Minting and burning capabilities - Creation timestamps

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `service_api_base_url` | string | No | Base URL of the Token Factory service API. Get this from the 'urls' field of your Token Factory service using GET /services. Example: 'https://u0xxxx-u0xxxx-tokenfactory.kaleido.io/api/v1'. If not provided, uses the default console base URL (may return empty results if no global tokens exist). |

#### 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 |

### Get Wallet Account Nonce

**Slug:** `KALEIDO_GET_WALLET_ACCOUNT_NONCE`

Retrieve the current nonce (transaction count) of a specific HD wallet account. The nonce is essential for signing Ethereum transactions - it ensures transactions are processed in order and prevents replay attacks. Call this before signing a transaction to get the correct nonce value. Prerequisites: - An HD Wallet service must be provisioned in your Kaleido environment - A wallet must exist (created via POST /wallets) - You need the service API base URL from GET /services endpoint

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `wallet_id` | string | Yes | The unique identifier of the HD wallet instance. Obtain this from the GET /wallets endpoint. |
| `account_index` | integer | Yes | The derivation index of the account within the HD wallet (0 to 2,147,483,648). Each index represents a unique Ethereum account derived from the wallet's seed. |
| `service_api_base_url` | string | Yes | The base URL of the HD Wallet service API. This is REQUIRED as the nonce endpoint is only available on HD Wallet service instances, not the console API. Obtain this URL from the service's 'urls' field via GET /services endpoint. Format: https://<service_host>/api/v1 |

#### 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 |

### Get Wallets

**Slug:** `KALEIDO_GET_WALLETS`

Tool to retrieve HD wallet IDs hosted in the service. Use after creating or importing HD wallets to enumerate available wallets.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `service_api_base_url` | string | No | Override the base URL for the HD Wallet service API, e.g., https://<service_host>/api/v1. If provided, the wallets will be retrieved from this service instead of the console base URL. |

#### 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 Organization

**Slug:** `KALEIDO_UPDATE_ORGANIZATION`

Tool to update a specific organization in Kaleido. Use when you need to modify organization properties such as name, billing details, or authentication settings. First obtain the org_id using the Get Organizations action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | User-friendly organization name to update |
| `plan` | string | No | Subscription plan name for the organization |
| `org_id` | string | Yes | The unique identifier of the organization to update. Obtain this from the Get Organizations action |
| `plan_id` | string | No | Subscription plan identifier |
| `delegate` | string | No | Email to be exposed on consortia memberships as contact info |
| `trial_ends` | string | No | Date when the organization's trial is expected to end (ISO8601 format) |
| `waitlisted` | boolean | No | Whether the organization is waitlisted |
| `support_level` | integer | No | The level of support entitlement for the organization (100-300) |
| `cognito_domain` | string | No | The Cognito domain name such as 'mydomain.auth.us-east-1.amazoncognito.com' (only used for Enterprise logins) |
| `cognito_region` | string | No | The Cognito region (only used for Enterprise logins) |
| `terms_accepted` | integer | No | Timestamp of the last time terms and conditions were accepted for this org (Unix milliseconds) |
| `billing_account` | object | No | Billing account details for updating an organization. |
| `cognito_client_id` | string | No | The client_id of the App client created for Kaleido (only used for Enterprise logins) |
| `cognito_user_pool_id` | string | No | The Cognito user pool ID (only used for Enterprise logins) |
| `cognito_client_secret` | string | No | The client_secret of the App client created for Kaleido (only used for Enterprise logins) |

#### 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 Organization Role

**Slug:** `KALEIDO_UPDATE_ORG_ROLE`

Update the role assignment for a user in a Kaleido organization. Use this to change a user's permissions level (e.g., promoting to admin). Returns the updated role details including the new revision token and updated timestamp.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role` | string ("admin") | Yes | The role to assign to the user within this organization |
| `org_id` | string | Yes | The unique Kaleido organization ID (e.g., 'u0cvzlsyw4'). Obtain this from the GET_ORGANIZATIONS action. |
| `role_id` | string | Yes | The unique identifier for the role assignment to update. Obtain this from the GET_ROLES action. |

#### 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 |

### Upsert Organization Role

**Slug:** `KALEIDO_UPSERT_ORGANIZATION_ROLE`

Upsert (create or update) a role assignment for a user in a Kaleido organization. Returns 201 for new roles and 200 for updates. The _revision field increments with each update. Use GET_ORGANIZATIONS to obtain valid org_id values.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role` | string ("admin") | Yes | The role to assign to the user within this organization. Currently only 'admin' is supported. |
| `org_id` | string | Yes | The unique Kaleido organization ID (e.g., 'u0cvzlsyw4'). Obtain this from the GET_ORGANIZATIONS action. |
| `role_id` | string | Yes | The unique role assignment ID (e.g., 'u0test1234'). For new roles, use a unique identifier; for updates, use the existing role ID. |
| `user_id` | string | Yes | The ID of the user to assign the role to. This is required when creating a new role assignment. |

#### 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 |