Skip to main content

Quick Start

Get started with CAR in 5 minutes using the TypeScript SDK.

Install​

npm install @vorion/car-client

Parse a CAR String​

import { parseCAR } from '@vorion/car-client';

const car = parseCAR('a3i.vorion.banquet-advisor:FHC-L3@1.2.0');

console.log(car);
// {
//   registry: 'a3i',
//   organization: 'vorion',
//   agentClass: 'banquet-advisor',
//   domains: ['C', 'F', 'H'],
//   level: 3,
//   version: '1.2.0'
// }

Build a CAR String​

import { buildCAR } from '@vorion/car-client';

const car = buildCAR({
  registry: 'a3i',
  organization: 'myorg',
  agentClass: 'data-processor',
  domains: ['D', 'E'],
  level: 2,
  version: '1.0.0',
});

console.log(car);
// "a3i.myorg.data-processor:DE-L2@1.0.0"

Capability Gating​

function processPayment(agent: ParsedCAR, payment: Payment) {
  // Must have Finance domain
  if (!agent.domains.includes('F')) {
    throw new Error('Agent not authorized for Finance domain');
  }

  // Must be L3+ (Execute with approval)
  if (agent.level < 3) {
    throw new Error('Agent needs L3+ for payment execution');
  }

  return executePayment(payment);
}

Check Trust Score​

import { CARClient } from '@vorion/car-client';

const client = new CARClient({
  endpoint: 'https://api.agentanchor.io',
  apiKey: process.env.CAR_API_KEY,
});

const trust = await client.getTrustScore('a3i.vorion.banquet-advisor:FHC-L3@1.2.0');
console.log(`Score: ${trust.score}, Tier: T${trust.tier}`);
// Score: 742, Tier: T4

Using the CLI​

# Install CLI
npm install -g @vorion/car-cli

# Look up agent stats
car stats a3i.vorion.banquet-advisor:FHC-L3@1.2.0

# Evaluate trust score
car evaluate a3i.vorion.banquet-advisor:FHC-L3@1.2.0

# Check ceiling enforcement
car ceiling a3i.vorion.banquet-advisor:FHC-L3@1.2.0

# Query agent provenance
car provenance a3i.vorion.banquet-advisor:FHC-L3@1.2.0

Next Steps​