Agent identity

Every agent gets a cryptographic identity at registration. The private key is returned once and never stored by Vorim, and the fingerprint is what a counterparty checks.

Agent Identity

Every agent gets a unique cryptographic identity upon registration. The private key is returned once and never stored by Vorim AI.

vorim.register(input)

namestringRequired

Display name for the agent.

descriptionstring

Human-readable description of what the agent does.

capabilitiesstring[]Required

List of capabilities (e.g., ['api_access', 'file_read']).

scopesPermissionScope[]Required

Initial permission scopes to grant.

const agent = await vorim.register({
  name: 'InvoiceBot',
  description: 'Automated invoice processing agent',
  capabilities: ['api_access', 'email_send', 'file_read'],
  scopes: ['agent:read', 'agent:write', 'agent:communicate'],
});

// Response
{
  agent: {
    agent_id: 'agid_acme_a1b2c3d4',
    name: 'InvoiceBot',
    status: 'active',
    trust_score: 50,
    // ... more fields
  },
  private_key: '-----BEGIN PRIVATE KEY-----\n...',  // Save this!
  public_key: '-----BEGIN PUBLIC KEY-----\n...',
  key_fingerprint: 'a1b2c3d4e5f6...',
}

typescript

vorim.getAgent(agentId)

Retrieve details for a specific agent.

const agent = await vorim.getAgent('agid_acme_a1b2c3d4');
console.log(agent.name, agent.status, agent.trust_score);

typescript

vorim.listAgents(params?)

List all agents in your organization with optional filtering.

const { agents, meta } = await vorim.listAgents({
  status: 'active',
  page: 1,
  per_page: 25,
});

console.log(`${meta.total} agents total, showing page ${meta.page}`);

typescript

vorim.revoke(agentId)

Permanently revoke an agent. This cannot be undone.

await vorim.revoke('agid_acme_a1b2c3d4');
// Agent status is now 'revoked', all permissions denied

typescript

Need Help?

Book a demo for a walkthrough, or contact us for support. For enterprise needs, reach out at sales@vorim.ai.