Skip to main content

Quick Start Guide

Follow these steps to explore the Registry Broker with the @hashgraphonline/standards-sdk.

Prerequisites​

  • Node.js 20 or later
  • pnpm 8+ (or npm)
  • Registry Broker API key (optional for free endpoints)
  • Hedera testnet account (optional for registration and credit demos)

Step 1 — Install the SDK​

pnpm add @hashgraphonline/standards-sdk
# npm install @hashgraphonline/standards-sdk

Step 2 — Configure the Environment​

Create a .env file in your project root:

REGISTRY_BROKER_API_URL=https://registry.hashgraphonline.com/api/v1
REGISTRY_BROKER_API_KEY=your-api-key # omit for unauthenticated search
HEDERA_ACCOUNT_ID=0.0.1234           # optional, needed for registration demos
HEDERA_PRIVATE_KEY=302e...           # optional, needed for registration demos

Load these values before interacting with the client (e.g. via dotenv).

Step 3 — Initialise the Client​

import { RegistryBrokerClient } from '@hashgraphonline/standards-sdk';

const client = new RegistryBrokerClient({
  baseUrl: process.env.REGISTRY_BROKER_API_URL,
  apiKey: process.env.REGISTRY_BROKER_API_KEY,
});

The client automatically normalises the base URL and uses globalThis.fetch. Provide your own fetch implementation if you need custom behaviour.

Step 4 — Discover Agents​

const keywordResults = await client.search({
  q: 'customer support',
  limit: 5,
  registry: 'hol',
  verified: true,
});

keywordResults.hits.forEach(hit => {
  console.log(hit.profile.display_name, hit.uaid);
});
const vectorResults = await client.vectorSearch({
  query: 'treasury risk monitoring assistant',
  limit: 3,
  filter: {
    registry: 'hol',
    capabilities: ['financial-services'],
  },
});

vectorResults.hits.forEach(hit => {
  console.log(hit.agent.profile.display_name, hit.score.toFixed(4));
});

Use the API reference for the full search parameter list, including metadata filters and namespace-specific search.

Step 5 — Start a Chat Session​

const firstHit = keywordResults.hits.at(0);
if (!firstHit) {
  throw new Error('No agents available for chat demo.');
}

const session = await client.chat.createSession({
  uaid: firstHit.uaid,
});

const reply = await client.chat.sendMessage({
  sessionId: session.sessionId,
  message: 'Hello! What can you help me with today?',
});

console.log(reply.content);

const history = await client.chat.getHistory(session.sessionId);
console.log(history.map(entry => `${entry.role}: ${entry.content}`));

await client.chat.endSession(session.sessionId);

The chat helpers support both UAIDs and direct agent URLs. Configure authentication through the auth field when the agent requires credentials.

Step 6 — Continue Learning​

Need help? Start with the FAQ or join the community on Hashinals Telegram.