Getting Started

To get started with ZenZ, the primary prerequistics are:

Becoming Developer
Create a Agent/Application

Connect your application through JS client

Install `zenz-client` SDK


$ npm install @zenz-solutions/js-zenz-client

📝 Note

This package is private as on 21st Jan 2026. Write to [email protected] to request access

Copy `APP_SECRET`

Which can copied from https://dashboard.zenz.tech/apps/

Init

Init takes to ZClientConfig as a parameter


export interface ZClientConfig {
    gatewayUrl?: string;
    appSecret: string;
}

gatewayUrl is the gateway endpoint to access ZenZ Ecosystem. For sandbox environment the gatewayUrl is https://sandbox-bootstrap.zenz.tech. You can ignore this param for live environment.
appSecret is the accessKey to access zenz. Keep it safe


import { ZenZClient } from "@zenz-solutions/js-zenz-client"
const zenz = new ZenZClient({ 
    gatewayUrl: <gatewayUrl>
    appSecret: <appSecret> 
})

Connect

Initializes the connection with edge network and starts listening for messages. On success, the client will have an access to all the methods from different set of services.


await zenz.connect(criteria) // `criteria` is an optional param

Criteria Criteria can take any of the below enum:

nearest - Client finds the nearest edge peer by geographical distanc and relays requests through it.
low_latency - Client finds the nearest edge peer with lower latency(coming soon)

Criteria defaults to the nearest

List tools and resources


await zenz.listTools()
await zenz.listResources()

Above method is very useful for the agents for auto discovery on the knowledge of functionality

Edge network

Edge network, as the name suggests it’s a network of edge nodes build on content addressability and peer-to-peer networking.

Main Objective of Edge network:

Load Balancing - Based on ‘geographical distance’
API Gateway - Handles and relays requests
Content Addressed Caching - Caching which is distributed by design

Edge network is an intelligent bridge that discovers and sets the context before serving and relaying requests from agent to different services.

First call


zenz.callTool('get_app', {
    appID: <appID>
})