Getting Started

To get started with ZenZ, the primary prerequistics are:

Becoming Developer
Configure your vault
Create a Agent/Application

Connect your application through our JS client

Install Client SDK


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

📝 Note

This package is private as of today. Write to [email protected] to get access.

Copy the APP_SECRET of your app.

`new ZenZClient`

ZClientConfig

Takes ZClientConfig as a parameter


 
type LBCriteria = 'nearest' | 'low_latency'
interface ZClientConfig {
    appSecret: string;
    environment?: string;
    criteria?: LBCriteria
}

Mandatory params

appSecret is the secret access Key to init and talk to zenz ecosystem. Keep it safe.

Optional params

environment is used to specify the zenz environment the client going to access. Defaults: sandbox
criteria used for initializing the connection with gateway/edge node based on criteria. Defaults: nearest. 📝 Note

As of today, client accepts only nearest for criteria


import { ZenZClient } from "@zenz-solutions/js-zenz-client"
const zClient = new ZenZClient({ 
    environment: 'sandbox'
    appSecret: <appSecret>
    criteria: 'nearest'
})

`Init`

This step mandatory after declaration, to initialize the connection with edge gateway and starts listening for messages. This function will authenticate the app and load-up the session to all the methods from different set of services.


await zClient.init()

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.

Verify connection


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