NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Kaleido connects to a Nagent workspace with an API key. Once it is connected, agents can call 29 Kaleido actions, such as "Add Organization Identity Proof", "Create API Key" and "Get API Key". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Kaleido, with input parameters and output schema.
KALEIDO_ADD_IDENTITY_PROOFAdd 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
A human-readable name for the identity proof, typically describing the certificate purpose (e.g., 'Root CA', 'Production Certificate')
Type of the identity proof. Currently only 'x509' certificates are supported. Defaults to 'x509'.
The Kaleido organization ID (e.g., 'u0cvzlsyw4'). Obtain this from the get_organizations action.
The Base64-encoded x509 certificate chain. This should be a valid PEM certificate converted to Base64 format.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KALEIDO_CREATE_API_KEYCreates 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
Optional human-readable name for the API key to help identify its purpose
The organization ID to create the API key for. Obtain this from the Get Organizations action
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KALEIDO_DELETE_API_KEYPermanently 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
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KALEIDO_DELETE_ORGANIZATION_IDENTITY_PROOFRemove an x509 identity proof from a Kaleido organization. This permanently deletes the identity proof. The deletion is irreversible.
Input parameters
The Kaleido organization ID (e.g., 'u0cvzlsyw4'). Obtain this from the get_organizations action.
The unique identifier of the identity proof to delete. You can find proof IDs by listing identity proofs for an organization.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KALEIDO_GET_API_KEYTool 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
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KALEIDO_GET_API_KEYSTool to retrieve all API keys associated with the organization. Use when you need an overview of existing API keys after authenticating.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KALEIDO_GET_APPLICATION_CREDENTIALSTool to retrieve application credentials for a specific environment. Use when you need to list DApp credentials after environment setup.
Input parameters
ID of the consortium
ID of the environment
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KALEIDO_GET_BILLING_SUMMARYRetrieves 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
The year (e.g., 2024, 2025). Defaults to current year if not specified.
The month name (e.g., january, february, etc.). Defaults to current month if not specified.
Organization identifier
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KALEIDO_GET_CONSORTIATool to retrieve all consortia associated with the organization. Use after authenticating to view existing consortia.
Input parameters
Number of records to skip for pagination (offset-based)
Maximum number of consortia to return per request
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KALEIDO_GET_EVENT_STREAMSList 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
Kaleido node ID exposing Ethconnect (used for URL composition)
Override base URL completely. If this already includes /eventstreams it will be used as-is.
Zone domain used to reach the Ethconnect gateway (e.g., us-east-1.connect.kaleido.io)
Kaleido environment ID (used for Ethconnect URL composition)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KALEIDO_GET_IDENTITY_PROOFTool 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
The Kaleido organization ID (e.g., 'u0cvzlsyw4'). Obtain this from the get_organizations action.
The unique identifier of the identity proof to retrieve (e.g., 'u0wpjdqkha').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KALEIDO_GET_INVITATIONSTool to retrieve all invitations for the current user where they are the target. Use after authenticating to view pending invitations.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KALEIDO_GET_MEMBERSHIPSTool to retrieve all memberships for the current user. Use after authenticating to list user memberships.
Input parameters
Optional Mongo-style query string to filter memberships
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KALEIDO_GET_ORGANIZATIONTool to retrieve details of a specific Kaleido organization by its ID. Use when you need to fetch information about a particular organization.
Input parameters
Unique organization identifier
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KALEIDO_GET_ORGANIZATION_PLANRetrieve 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
The unique Kaleido organization ID (e.g., 'u0cvzlsyw4'). Obtain this from the GET_ORGANIZATIONS action.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KALEIDO_GET_ORGANIZATIONSRetrieves 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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KALEIDO_GET_ORG_BILLING_PROVIDERRetrieves 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
Unique organization identifier
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KALEIDO_GET_PLANSRetrieve 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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KALEIDO_GET_REGIONSRetrieve 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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KALEIDO_GET_RELEASESRetrieve 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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KALEIDO_GET_ROLE_BY_IDRetrieve 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
The unique Kaleido organization ID (e.g., 'u0cvzlsyw4'). Obtain this from the GET_ORGANIZATIONS action.
The unique role assignment ID (e.g., 'u0xvg2zbom'). Obtain this from the GET_ROLES action.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KALEIDO_GET_ROLESRetrieve 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
The unique Kaleido organization ID (e.g., 'u0cvzlsyw4'). Obtain this from the GET_ORGANIZATIONS action.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KALEIDO_GET_SERVICESTool to retrieve all services the current user owns or can see. Use after authenticating to list available services.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KALEIDO_GET_TOKEN_FACTORY_TOKENSRetrieves 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
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KALEIDO_GET_WALLET_ACCOUNT_NONCERetrieve 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
The unique identifier of the HD wallet instance. Obtain this from the GET /wallets endpoint.
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.
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KALEIDO_GET_WALLETSTool to retrieve HD wallet IDs hosted in the service. Use after creating or importing HD wallets to enumerate available wallets.
Input parameters
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KALEIDO_UPDATE_ORGANIZATIONTool 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
User-friendly organization name to update
Subscription plan name for the organization
The unique identifier of the organization to update. Obtain this from the Get Organizations action
Subscription plan identifier
Email to be exposed on consortia memberships as contact info
Date when the organization's trial is expected to end (ISO8601 format)
Whether the organization is waitlisted
The level of support entitlement for the organization (100-300)
The Cognito domain name such as 'mydomain.auth.us-east-1.amazoncognito.com' (only used for Enterprise logins)
The Cognito region (only used for Enterprise logins)
Timestamp of the last time terms and conditions were accepted for this org (Unix milliseconds)
Billing account details for updating an organization.
The client_id of the App client created for Kaleido (only used for Enterprise logins)
The Cognito user pool ID (only used for Enterprise logins)
The client_secret of the App client created for Kaleido (only used for Enterprise logins)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KALEIDO_UPDATE_ORG_ROLEUpdate 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
The role to assign to the user within this organization
The unique Kaleido organization ID (e.g., 'u0cvzlsyw4'). Obtain this from the GET_ORGANIZATIONS action.
The unique identifier for the role assignment to update. Obtain this from the GET_ROLES action.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KALEIDO_UPSERT_ORGANIZATION_ROLEUpsert (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
The role to assign to the user within this organization. Currently only 'admin' is supported.
The unique Kaleido organization ID (e.g., 'u0cvzlsyw4'). Obtain this from the GET_ORGANIZATIONS action.
The unique role assignment ID (e.g., 'u0test1234'). For new roles, use a unique identifier; for updates, use the existing role ID.
The ID of the user to assign the role to. This is required when creating a new role assignment.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 29 Kaleido actions on Nagent, including "Add Organization Identity Proof", "Create API Key" and "Get API Key". Add Organization Identity Proof: Add an x509 identity proof to a Kaleido organization. Each action is listed on this page with its input parameters and its output.
Kaleido connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Add Organization Identity Proof takes 3 required inputs: name, org_id and payload. It also takes 1 optional input: type. It returns data, error and successful.