@vorim/sdk

Official TypeScript SDK for Vorim AI — the AI Agent Identity & Trust Layer.

Register agents with cryptographic identities, enforce fine-grained permissions, emit immutable audit trails, and verify trust scores.

Install

npm install @vorim/sdk

Quick Start

import createVorim from '@vorim/sdk';

const vorim = createVorim({
  apiKey: 'agid_sk_live_your_api_key_here',
});

// Register an agent with Ed25519 keypair
const { agent, private_key } = await vorim.register({
  name: 'InvoiceBot',
  capabilities: ['api_access', 'email_send'],
  scopes: ['agent:read', 'agent:write'],
});

// Check permissions (sub-5ms via Redis cache)
const { allowed } = await vorim.check(agent.agent_id, 'agent:write');

// Emit audit event
await vorim.emit({
  agent_id: agent.agent_id,
  event_type: 'api_request',
  action: 'POST /invoices',
  result: 'success',
});

// Verify trust (public API, no auth needed)
const trust = await vorim.verify(agent.agent_id);
console.log(trust.trust_score); // 0-100

Features

Cryptographic Identity — Ed25519 keypairs, SHA-256 fingerprints
7 Permission Scopes — agent:read, write, execute, transact, communicate, delegate, elevate
Immutable Audit Trail — ULID-ordered events with content hashes
Trust Scoring — Multi-factor algorithm (0-100)
Payload Signing — Client-side Ed25519 signatures via Web Crypto or Node.js crypto
Dual Runtime — Works in Node.js 18+ and modern browsers

API

Method	Description
`vorim.register(input)`	Register agent with keypair
`vorim.getAgent(agentId)`	Get agent details
`vorim.listAgents(params?)`	List organisation agents
`vorim.revoke(agentId)`	Permanently revoke agent
`vorim.check(agentId, scope)`	Check permission
`vorim.grant(agentId, scope, options?)`	Grant permission
`vorim.emit(event)`	Emit single audit event
`vorim.emitBatch(events)`	Emit up to 1,000 events
`vorim.verify(agentId)`	Public trust verification
`vorim.sign(payload, privateKey)`	Ed25519 payload signing

Configuration

const vorim = createVorim({
  apiKey: 'agid_sk_live_...',     // Required — your API key
  baseUrl: 'https://api.vorim.ai', // Optional — API base URL
  timeout: 10000,                   // Optional — request timeout (ms)
});

Error Handling

import { VorimError } from '@vorim/sdk';

try {
  await vorim.check('invalid_id', 'agent:read');
} catch (err) {
  if (err instanceof VorimError) {
    console.log(err.status);  // 404
    console.log(err.code);    // 'AGENT_NOT_FOUND'
    console.log(err.message); // 'Agent not found'
  }
}

Documentation

Full documentation at vorim.dev/docs

License

MIT