SDK Reference

npm install @nullbridge/sdk

import { NullBridge } from '@nullbridge/sdk';

const nb = new NullBridge({
  licenseKey:    process.env.NULLBRIDGE_LICENSE_KEY, // required
  apiUrl:        'https://api.nullbridge.ai',         // default
  skipLicense:   false,    // set true for local dev only
  autoShutdown:  true,     // shut down if license is revoked
  checkInterval: 86400000, // license recheck interval ms (default: 24h)
  debug:         false,    // enable verbose logging
});

await nb.init();

const agent = await nb.agents.register({
  id:     'fraud-detector-001',  // required — stable unique identifier
  name:   'Fraud Detector',      // required — display name
  type:   'llm',                 // required — 'llm' | 'rpa' | 'workflow' | 'custom'
  model:  'gpt-4o',              // optional
  scopes: ['read:transactions', 'write:alerts'],
  metadata: {
    team:        'risk',
    environment: 'prod',
    owner_email: 'team@company.com',
  },
  heartbeatInterval: 60000,
});

await agent.logAction('analyze_transaction', {
  txId:   'TX-1234',
  amount: 5000,
  result: 'approved',
});

if (!agent.hasScope('write:alerts')) {
  throw new Error('Agent not authorized');
}

await agent.deregister();

await nb.audit.log({
  agentId:     agent.id,
  agentName:   agent.name,
  action:      'process_claim',
  resource:    'claim:CLM-001',
  outcome:     'success',
  details:     { amount: 15000 },
  ip:          req.ip,
  duration_ms: 1240,
});

await nb.audit.batch([
  { agentId: agent.id, agentName: agent.name, action: 'read_record',  outcome: 'success' },
  { agentId: agent.id, agentName: agent.name, action: 'write_report', outcome: 'success' },
]);

await nb.audit.logViolation(agent.id, agent.name, 'delete_record', 'scope_denied');

const credId = await nb.credentials.store({
  agentId: agent.id,
  name:    'openai-api-key',
  value:   process.env.OPENAI_API_KEY,
  type:    'api_key',
  ttl:     86400,
});

const apiKey = await nb.credentials.get(credId);

await nb.credentials.rotate(credId, newApiKey);

await nb.credentials.revoke(credId);

nb.anomaly.record(agent.id, 'api_calls_per_minute', 14);
nb.anomaly.record(agent.id, 'tokens_used', 3200);

nb.anomaly.onAlert(alert => {
  console.error(`Anomaly: ${alert.metric} — z=${alert.zScore}`);
});

const { anomalous, zScore } = nb.anomaly.check(agent.id, 'api_calls', 500);

process.on('SIGTERM', async () => {
  await nb.shutdown();
  process.exit(0);
});

import {
  NullBridgeLicenseError,
  NullBridgeApiError,
  NullBridgeCredentialError,
} from '@nullbridge/sdk';

try {
  await nb.init();
} catch (err) {
  if (err instanceof NullBridgeLicenseError) {
    console.error('License invalid:', err.reason);
  }
}