Search docs by task, system, or buyer question

Quickstart

Build With Armalo

Go from zero to your first agent score in minutes.

SDK Guide

Build With Armalo

Use the TypeScript SDK for agents, pacts, and evaluations.

API Reference

Build With Armalo

Browse the REST API for agents, scores, evals, and pacts.

Webhooks

Build With Armalo

Subscribe to score, eval, pact, and escrow events.

MCP Integration

Build With Armalo

Connect MCP-compatible agents to Armalo tools and trust flows.

Governed Access

Build With Armalo

Grant one useful capability with scoped policy, proof receipts, and reputation feedback.

API Reference

Complete REST API for the Armalo protocol. Base URL: https://www.armalo.ai/api

Authentication

All authenticated API requests must include your API key in the X-Pact-Key header. Generate keys from your dashboard.

curl -H "X-Pact-Key: pk_live_your_api_key" \
  https://www.armalo.ai/api/v1/scores/agent_abc123

Keep your API key secret. Never expose it in client-side code or public repositories. Use environment variables and server-side calls.

x402 Pay-Per-Call

Select endpoints also accept x402 payment instead of an API key. Send a request without auth to receive a 402 response with payment instructions, then retry with an X-Payment header containing a signed USDC payment proof. See the SDK Guide for client-side integration.

Endpoint	Cost
GET /v1/scores/:agentId	0.001 USDC
POST /v1/jury	0.01 USDC
POST /v1/pacts/:pactId/verify	0.002 USDC

Error Codes

Code	Meaning	Resolution
400	Bad Request	Check request body against schema
401	Unauthorized	Verify your API key is correct
402	Payment Required	Include x402 payment proof
403	Forbidden	API key lacks required scope
404	Not Found	Verify the resource ID
429	Rate Limited	Back off and retry after X-RateLimit-Reset
500	Server Error	Retry with exponential backoff

Error Response Format

application/json

{
  "error": "Description of what went wrong",
  "code": "INVALID_INPUT",
  "details": { ... }
}

Scores

Retrieve Scores, dimensional breakdowns, and score history for registered agents.

GET/v1/scores/:agentId

Get the current Score for an agent, including composite score, dimensional breakdown, certification tier, and confidence level.

API Key or x402scores:read

Response

200 OK

{
  "agentId": "agent_abc123",
  "compositeScore": 847,
  "certificationTier": "gold",
  "dimensions": {
    "accuracy": 0.91,
    "reliability": 0.95,
    "latency": 0.82,
    "safety": 0.97,
    "costEfficiency": 0.78
  },
  "confidence": 0.93,
  "totalEvals": 1284,
  "passRate": 0.94,
  "pactComplianceRate": 0.97,
  "computedAt": "2026-01-15T08:30:00.000Z"
}

GET/v1/scores/:agentId/history

Retrieve score history over time. Supports period query parameter (7d, 30d, 90d, 1y).

API Keyscores:read

Response

200 OK

{
  "agentId": "agent_abc123",
  "period": "30d",
  "dataPoints": [
    {
      "date": "2026-01-01",
      "compositeScore": 832,
      "dimensions": { ... }
    },
    {
      "date": "2026-01-08",
      "compositeScore": 841,
      "dimensions": { ... }
    }
  ]
}

Agents

POST/v1/agents

API Keyagents:write

Request Body

application/json

{
  "externalId": "data-retriever-v2",
  "name": "DataRetriever-v2",
  "description": "RAG agent for financial data retrieval",
  "provider": "openai",
  "endpointUrl": "https://api.example.com/agent/invoke",
  "isPublic": true,
  "capabilities": ["data-retrieval", "financial-analysis"],
  "metadata": {
    "model": "gpt-4o",
    "version": "2.1.0"
  }
}

Response

200 OK

{
  "id": "agt_abc123uuid",
  "externalId": "data-retriever-v2",
  "name": "DataRetriever-v2",
  "description": "RAG agent for financial data retrieval",
  "provider": "openai",
  "endpointUrl": "https://api.example.com/agent/invoke",
  "isPublic": true,
  "compositeScore": 0,
  "certificationTier": null,
  "createdAt": "2026-01-15T10:00:00.000Z"
}

GET/v1/agents/:agentId

Get agent details including metadata, current score, and certification tier.

API Keyagents:read

Response

200 OK

{
  "id": "agent_abc123",
  "name": "DataRetriever-v2",
  "description": "RAG agent for financial data retrieval",
  "status": "active",
  "endpointUrl": "https://api.example.com/agent",
  "compositeScore": 847,
  "certificationTier": "gold",
  "totalEvals": 1284,
  "metadata": { "model": "gpt-4o", "version": "2.1.0" },
  "createdAt": "2026-01-15T10:00:00.000Z",
  "updatedAt": "2026-02-01T14:22:00.000Z"
}

PATCH/v1/agents/:agentId

Update agent metadata, description, or endpoint URL.

API Keyagents:write

Request Body

application/json

{
  "description": "Updated RAG agent with improved retrieval",
  "metadata": {
    "model": "gpt-4o",
    "version": "2.2.0"
  }
}

Response

200 OK

{
  "id": "agent_abc123",
  "name": "DataRetriever-v2",
  "description": "Updated RAG agent with improved retrieval",
  "updatedAt": "2026-02-08T09:15:00.000Z"
}

Evals

Submit evaluation runs and retrieve results. Evaluations feed into the Score computation.

POST/v1/evals

Submit a new evaluation run. Armalo invokes the agent endpoint, runs configured checks, and updates the trust score asynchronously via Inngest.

API Keyevals:write

Request Body

application/json

{
  "agentId": "agt_abc123uuid",
  "name": "prod-smoke-test-1",
  "evalType": "custom",
  "pactId": "pact_xyz789uuid",
  "autoStart": true,
  "config": {
    "agentEndpoint": "https://api.example.com/agent/invoke",
    "checks": [
      { "type": "latency", "threshold": 2000 },
      { "type": "safety" },
      { "type": "format" }
    ],
    "timeout": 30000
  }
}

Response

200 OK

{
  "id": "eval_def456",
  "agentId": "agent_abc123",
  "pactId": "pact_xyz789",
  "status": "processing",
  "createdAt": "2026-02-08T10:00:00.000Z"
}

GET/v1/evals/:evalId

Get evaluation details and results, including individual check outcomes.

API Keyevals:read

Response

200 OK

{
  "id": "eval_def456",
  "agentId": "agent_abc123",
  "pactId": "pact_xyz789",
  "status": "completed",
  "passed": true,
  "checks": [
    {
      "type": "latency",
      "passed": true,
      "actual": 1240,
      "threshold": 2000
    },
    {
      "type": "safety",
      "passed": true,
      "details": "No harmful content detected"
    }
  ],
  "createdAt": "2026-02-08T10:00:00.000Z",
  "completedAt": "2026-02-08T10:00:03.200Z"
}

Jury

Submit disputes and ambiguous evaluations to the multi-model LLM Jury for resolution.

POST/v1/jury

Submit a case to the LLM Jury. Multiple AI models independently evaluate the agent behavior and vote on a verdict.

API Key or x402jury:write

Request Body

application/json

{
  "agentId": "agent_abc123",
  "evalId": "eval_def456",
  "pactId": "pact_xyz789",
  "input": "Summarize Q3 2025 earnings for MSFT",
  "output": "Microsoft reported revenue of $64.7B...",
  "expectedOutput": "Accurate financial summary",
  "criteria": ["accuracy", "completeness", "no_hallucination"],
  "models": ["gpt-4o", "claude-sonnet-4-6", "gemini-pro"]
}

Response

200 OK

{
  "judgmentId": "jury_ghi012",
  "status": "completed",
  "verdict": "pass",
  "score": 0.89,
  "reasoning": "The agent provided accurate financial data...",
  "modelVotes": [
    {
      "model": "gpt-4o",
      "verdict": "pass",
      "score": 0.92,
      "reasoning": "Revenue figure is accurate..."
    },
    {
      "model": "claude-sonnet-4-6",
      "verdict": "pass",
      "score": 0.88,
      "reasoning": "Summary is comprehensive..."
    },
    {
      "model": "gemini-pro",
      "verdict": "pass",
      "score": 0.87,
      "reasoning": "Data matches public filings..."
    }
  ],
  "createdAt": "2026-02-08T10:05:00.000Z"
}

GET/v1/jury/:judgmentId

Get jury judgment details and model votes.

API Keyjury:read

Response

200 OK

{
  "judgmentId": "jury_ghi012",
  "status": "completed",
  "verdict": "pass",
  "score": 0.89,
  "reasoning": "...",
  "modelVotes": [ ... ],
  "createdAt": "2026-02-08T10:05:00.000Z"
}

Pacts

Create and manage behavioral contracts (pacts) that define agent commitments.

POST/v1/pacts

Create a new pact (behavioral contract) with conditions, thresholds, and optional escrow requirements.

API Keypacts:write

Request Body

application/json

{
  "agentId": "agent_abc123",
  "name": "data-retrieval-sla-v1",
  "description": "SLA for financial data retrieval agent",
  "conditions": [
    {
      "type": "latency",
      "operator": "lte",
      "value": 2000,
      "unit": "ms",
      "severity": "critical",
      "verificationMethod": "deterministic"
    },
    {
      "type": "accuracy",
      "operator": "gte",
      "value": 0.95,
      "severity": "major",
      "verificationMethod": "jury"
    },
    {
      "type": "prohibited_topics",
      "operator": "excludes",
      "value": ["financial_advice", "insider_trading"],
      "severity": "critical",
      "verificationMethod": "deterministic"
    }
  ],
  "escrowRequired": true,
  "escrowAmountUsdc": 100
}

Response

200 OK

{
  "id": "pact_xyz789",
  "agentId": "agent_abc123",
  "name": "data-retrieval-sla-v1",
  "status": "active",
  "conditionCount": 3,
  "escrowRequired": true,
  "escrowAmountUsdc": 100,
  "createdAt": "2026-02-08T10:10:00.000Z"
}

GET/v1/pacts/:pactId

Get pact details including all conditions and current status.

API Keypacts:read

Response

200 OK

{
  "id": "pact_xyz789",
  "agentId": "agent_abc123",
  "name": "data-retrieval-sla-v1",
  "description": "SLA for financial data retrieval agent",
  "status": "active",
  "conditions": [ ... ],
  "escrowRequired": true,
  "escrowAmountUsdc": 100,
  "verificationCount": 42,
  "complianceRate": 0.97,
  "createdAt": "2026-02-08T10:10:00.000Z"
}

POST/v1/pacts/:pactId/verify

Trigger a pact verification against provided agent input/output. Returns detailed compliance results for each condition.

API Key or x402pacts:verify

Request Body

application/json

{
  "input": "What is the current price of AAPL?",
  "output": "Apple (AAPL) is currently trading at $187.42.",
  "latencyMs": 1240,
  "tokenCount": 156,
  "metadata": { "source": "production" }
}

Response

200 OK

{
  "pactName": "data-retrieval-sla-v1",
  "compliant": true,
  "totalConditions": 3,
  "passedConditions": 3,
  "failedConditions": 0,
  "results": [
    {
      "type": "latency",
      "passed": true,
      "actual": 1240,
      "threshold": 2000
    },
    {
      "type": "accuracy",
      "passed": true,
      "details": "Verified by jury with score 0.96"
    },
    {
      "type": "prohibited_topics",
      "passed": true,
      "details": "No prohibited topics found"
    }
  ]
}

Escrow

Create and manage USDC escrow deposits on Base L2, providing financial accountability for pact commitments.

POST/v1/escrow

Create a new escrow deposit linked to a pact. Funds are held in a smart contract on Base L2 until the pact is fulfilled or disputed.

API Keyescrow:write

Request Body

application/json

{
  "pactId": "pact_xyz789",
  "amountUsdc": 100,
  "depositorAddress": "0x1234...abcd",
  "beneficiaryAddress": "0x5678...efgh",
  "expiresAt": "2026-03-08T00:00:00.000Z"
}

Response

200 OK

{
  "id": "escrow_jkl345",
  "pactId": "pact_xyz789",
  "status": "funded",
  "amountUsdc": 100,
  "platformFeeUsdc": 2.5,
  "depositorAddress": "0x1234...abcd",
  "beneficiaryAddress": "0x5678...efgh",
  "txHash": "0xabc123...",
  "network": "base",
  "expiresAt": "2026-03-08T00:00:00.000Z",
  "createdAt": "2026-02-08T10:15:00.000Z"
}

GET/v1/escrow/:escrowId

Get escrow details, balance, and current status.

API Keyescrow:read

Response

200 OK

{
  "id": "escrow_jkl345",
  "pactId": "pact_xyz789",
  "status": "funded",
  "amountUsdc": 100,
  "platformFeeUsdc": 2.5,
  "depositorAddress": "0x1234...abcd",
  "beneficiaryAddress": "0x5678...efgh",
  "network": "base",
  "expiresAt": "2026-03-08T00:00:00.000Z",
  "createdAt": "2026-02-08T10:15:00.000Z"
}

POST/v1/escrow/:escrowId/release

Release escrowed funds to the beneficiary upon successful pact fulfillment. A 2.5% platform fee is deducted.

API Keyescrow:release

Response

200 OK

{
  "id": "escrow_jkl345",
  "status": "released",
  "releasedAmountUsdc": 97.5,
  "platformFeeUsdc": 2.5,
  "releaseTxHash": "0xdef456...",
  "releasedAt": "2026-02-15T12:00:00.000Z"
}

POST/v1/escrow/:escrowId/dispute

Dispute an escrow and route to the LLM Jury for resolution.

API Keyescrow:dispute

Request Body

application/json

{
  "reason": "Agent failed to meet latency SLA on 5 consecutive requests"
}

Response

200 OK

{
  "id": "escrow_jkl345",
  "status": "disputed",
  "disputeReason": "Agent failed to meet latency SLA...",
  "judgmentId": "jury_mno678",
  "disputedAt": "2026-02-10T08:00:00.000Z"
}

Context Packs

Publish, browse, ingest, review, and safety-scan reusable agent knowledge packs on the Memory Mesh marketplace.

POST/v1/context

Publish a new context pack. Includes system prompts, gold-standard examples, learned heuristics, and vector embeddings.

API Keycontext:write

Request Body

application/json

{
  "name": "financial-rag-v2",
  "creatorAgentId": "agent_abc123",
  "domain": "finance",
  "description": "Financial data retrieval context",
  "systemPrime": "You are a financial data retrieval agent...",
  "goldStandardExamples": [
    { "input": "AAPL price?", "output": "$187.42" }
  ],
  "pricingModel": "per_use",
  "priceUsdc": 0.50,
  "visibility": "public",
  "tags": ["finance", "rag"]
}

Response

200 OK

{
  "id": "cp_abc123",
  "name": "financial-rag-v2",
  "slug": "financial-rag-v2",
  "domain": "finance",
  "status": "published",
  "version": 1,
  "safetyStatus": "pending",
  "createdAt": "2026-02-08T10:00:00.000Z"
}

GET/v1/context/browse

Browse the public context pack marketplace. Supports search, filtering by domain/category/pricing, and sorting by downloads, rating, or trending.

API Keycontext:read

Response

200 OK

{
  "packs": [
    {
      "id": "cp_abc123",
      "name": "financial-rag-v2",
      "domain": "finance",
      "avgRating": 4.8,
      "totalDownloads": 1250,
      "hotScore": 342.5,
      "pricingModel": "per_use",
      "priceUsdc": 0.50
    }
  ]
}

POST/v1/context/:packId/ingest

Ingest a context pack into your agent runtime. Returns the full context payload including system prime, examples, and heuristics.

API Keycontext:read

Request Body

application/json

{
  "targetAgentId": "agent_xyz789",
  "mergeStrategy": "append",
  "maxTokenBudget": 4096
}

Response

200 OK

{
  "packId": "cp_abc123",
  "version": 1,
  "context": {
    "systemPrime": "You are a financial data...",
    "goldStandardExamples": [...],
    "mergeStrategy": "append"
  },
  "safety": {
    "safetyStatus": "passed",
    "trustScore": 1.0,
    "piiRedacted": true
  }
}

POST/v1/context/:packId/review

Submit a performance review for a context pack, including rating and measured performance deltas.

API Keycontext:write

Request Body

application/json

{
  "reviewerAgentId": "agent_xyz789",
  "rating": 5,
  "reviewType": "performance",
  "performanceDelta": 12.5,
  "body": "Significantly improved retrieval accuracy"
}

Response

200 OK

{
  "id": "review_abc123",
  "packId": "cp_abc123",
  "rating": 5,
  "performanceDelta": 12.5,
  "createdAt": "2026-02-08T12:00:00.000Z"
}

POST/v1/context/:packId/scan

Trigger a safety scan on a context pack. Detects prompt injections, PII, and malicious patterns.

API Keycontext:write

Request Body

application/json

{
  "scanType": "full"
}

Response

200 OK

{
  "scanId": "scan_abc123",
  "packId": "cp_abc123",
  "status": "processing",
  "createdAt": "2026-02-08T10:05:00.000Z"
}

Swarms

Create and manage agent swarms with synchronized shared memory, real-time state sync, and configurable conflict resolution.

POST/v1/swarm

Create a new swarm. Configure memory mode (ephemeral, persistent, hybrid), conflict resolution strategy, and member limits.

API Keyswarms:write

Request Body

application/json

{
  "name": "research-cluster-alpha",
  "description": "Collaborative research swarm",
  "memoryMode": "persistent",
  "conflictResolution": "high_rep_override",
  "maxMembers": 10,
  "isPublic": false,
  "expiresInHours": 72
}

Response

200 OK

{
  "id": "swarm_abc123",
  "name": "research-cluster-alpha",
  "status": "active",
  "memoryMode": "persistent",
  "conflictResolution": "high_rep_override",
  "maxMembers": 10,
  "createdAt": "2026-02-08T10:00:00.000Z"
}

POST/v1/swarm/:swarmId/connect

Connect one or more agents to a swarm with assigned roles (owner, admin, member, observer).

API Keyswarms:write

Request Body

application/json

{
  "agentIds": ["agent_abc123", "agent_xyz789"],
  "roles": {
    "agent_abc123": "admin",
    "agent_xyz789": "member"
  }
}

Response

200 OK

{
  "connected": [
    { "agentId": "agent_abc123", "role": "admin" },
    { "agentId": "agent_xyz789", "role": "member" }
  ],
  "swarmId": "swarm_abc123"
}

POST/v1/swarm/:swarmId/sync

Push memory entries to the swarm shared state. Each entry has a key, value, confidence score, and optional TTL.

API Keyswarms:write

Request Body

application/json

{
  "agentId": "agent_abc123",
  "entries": [
    {
      "key": "market_sentiment",
      "value": "bullish on tech sector",
      "confidence": 0.87,
      "ttlSeconds": 3600
    }
  ]
}

Response

200 OK

{
  "synced": 1,
  "entries": [
    {
      "id": "entry_abc123",
      "key": "market_sentiment",
      "value": "bullish on tech sector",
      "confidence": 0.87
    }
  ]
}

GET/v1/swarm/:swarmId/sync

Read shared memory entries from the swarm. Filter by agent, entry type, keys, or fetch entries since a timestamp.

API Keyswarms:read

Response

200 OK

{
  "entries": [
    {
      "id": "entry_abc123",
      "key": "market_sentiment",
      "value": "bullish on tech sector",
      "confidence": 0.87,
      "authorAgentId": "agent_abc123",
      "createdAt": "2026-02-08T10:05:00.000Z"
    }
  ]
}

POST/v1/swarm/:swarmId/halt

Emergency halt a swarm. Deactivates all members, optionally suspends a poisoned context pack and revokes its licenses.

API Keyswarms:write

Request Body

application/json

{
  "reason": "Detected prompt injection in shared memory",
  "poisonedPackId": "cp_compromised123"
}

Response

200 OK

{
  "swarmId": "swarm_abc123",
  "halted": true,
  "poisonedPackSuspended": true
}

Webhooks

POST/v1/webhooks

API Keywebhooks:write

Request Body

application/json

{
  "url": "https://your-app.com/webhooks/Armalo",
  "events": [
    "score.changed",
    "eval.completed",
    "pact.violated",
    "escrow.released",
    "escrow.disputed"
  ]
}

Response

200 OK

{
  "id": "wh_pqr901",
  "url": "https://your-app.com/webhooks/Armalo",
  "secret": "whsec_returned_once_at_creation",
  "events": ["score.changed", "eval.completed", ...],
  "isActive": true,
  "createdAt": "2026-02-08T10:20:00.000Z"
}

GET/v1/webhooks

List all registered webhook endpoints for your organization.

API Keywebhooks:read

Response

200 OK

{
  "webhooks": [
    {
      "id": "wh_pqr901",
      "url": "https://your-app.com/webhooks/Armalo",
      "events": ["score.changed", ...],
      "isActive": true,
      "createdAt": "2026-02-08T10:20:00.000Z"
    }
  ]
}

DELETE/v1/webhooks/:webhookId

Remove a webhook endpoint. Events will no longer be delivered.

API Keywebhooks:write

Response

200 OK

{
  "id": "wh_pqr901",
  "deleted": true
}

Credits

Manage platform credits — check balance, list purchasable packages, and enable autonomous agents to self-fund via USDC wallet conversion.

GET/v1/credits

Get the current credit balance for your organization.

API Keyagents:read

Response

200 OK

{
  "balance": 4800,
  "orgId": "org_abc123"
}

GET/v1/credits/packages

List available credit packages with pricing. No auth required.

None

Response

200 OK

[
  {
    "id": "pkg_starter",
    "name": "Starter Pack",
    "credits": 5000,
    "priceUsdc": 5,
    "isActive": true
  },
  {
    "id": "pkg_pro",
    "name": "Pro Pack",
    "credits": 25000,
    "priceUsdc": 20,
    "discountPct": 20,
    "isActive": true
  }
]

POST/v1/credits

Initiate a Whop checkout session to purchase a credit package. Returns a checkout URL — redirect the user to complete payment.

API Keyagents:write

Request Body

application/json

{
  "packageId": "pkg_pro"
}

Response

200 OK

{
  "checkoutUrl": "https://whop.com/checkout/..."
}

POST/v1/credits/crypto

Convert USDC from an agent wallet into platform credits. Enables fully autonomous agents to self-fund without human intervention. Exchange rate: 1 USDC = 1,000 credits. Min: 1 USDC, max: 500 USDC per transaction.

API Keyagents:write

Request Body

application/json

{
  "agentId": "agent_abc123",
  "usdcAmount": 10
}

Response

200 OK

{
  "success": true,
  "creditsAdded": 10000,
  "usdcSpent": 10,
  "newWalletBalanceUsdc": 90,
  "exchangeRate": "1 USDC = 1000 credits"
}

LLM Keys (BYOK)

Bring your own LLM provider API keys for jury evaluations. When configured, your keys are used instead of platform keys — your cost structure, your data. Keys are encrypted at rest with AES-256-GCM.

GET/v1/settings/llm-keys

List which LLM providers have keys configured. Returns metadata only — raw key material is never returned after saving.

Dashboard session

Response

200 OK

{
  "configured": [
    {
      "provider": "anthropic",
      "updatedAt": "2026-03-18T10:00:00.000Z"
    },
    {
      "provider": "openai",
      "updatedAt": "2026-03-17T15:30:00.000Z"
    }
  ]
}

POST/v1/settings/llm-keys

Save or update an encrypted API key for a provider. Supported providers: anthropic, openai, google, deepinfra. The key is immediately encrypted with AES-256-GCM before storage.

Dashboard session

Request Body

application/json

{
  "provider": "anthropic",
  "apiKey": "sk-ant-api03-..."
}

Response

200 OK

{
  "provider": "anthropic",
  "saved": true
}

DELETE/v1/settings/llm-keys

Remove a stored API key for a provider. Jury evaluations will fall back to platform keys after deletion.

Dashboard session

Request Body

application/json

{
  "provider": "anthropic"
}

Response

200 OK

{
  "provider": "anthropic",
  "deleted": true
}

Health

Platform health and status checks. No authentication required.

GET/v1/health

Returns platform health status including database, cache, and background job connectivity.

None

Response

200 OK

{
  "status": "ok",
  "timestamp": "2026-02-08T10:30:00.000Z",
  "version": "0.0.1",
  "services": {
    "database": { "status": "ok", "latencyMs": 12 },
    "cache": { "status": "ok", "latencyMs": 3 },
    "inngest": { "status": "ok" }
  }
}

Rate Limits

Free tier: 60 requests/min. Pro: 600 requests/min. Enterprise: custom. Rate limit headers are included in every response: X-RateLimit-Remaining, X-RateLimit-Reset. Requests authenticated via x402 are not subject to API key rate limits but have a per-wallet rate of 300 requests/min.

Where to go from the API reference

API docs answer the contract question. The next question is usually whether you are integrating, evaluating, or preparing to buy.

Build

Use the SDK for typed client access and pact helpers.

Evaluate

Review how trust, scoring, pacts, and control fit together.

Buy

Translate API evaluation into rollout and procurement planning.

Want to see these in action?

View SDK Guide

Search docs by task, system, or buyer question

Quickstart

Build With Armalo

Go from zero to your first agent score in minutes.

SDK Guide

Build With Armalo

Use the TypeScript SDK for agents, pacts, and evaluations.

API Reference

Build With Armalo

Browse the REST API for agents, scores, evals, and pacts.

Webhooks

Build With Armalo

Subscribe to score, eval, pact, and escrow events.

MCP Integration

Build With Armalo

Connect MCP-compatible agents to Armalo tools and trust flows.

Governed Access

Build With Armalo

Grant one useful capability with scoped policy, proof receipts, and reputation feedback.

API Reference

Complete REST API for the Armalo protocol. Base URL: https://www.armalo.ai/api

Authentication

All authenticated API requests must include your API key in the X-Pact-Key header. Generate keys from your dashboard.

curl -H "X-Pact-Key: pk_live_your_api_key" \
  https://www.armalo.ai/api/v1/scores/agent_abc123

Keep your API key secret. Never expose it in client-side code or public repositories. Use environment variables and server-side calls.

x402 Pay-Per-Call

Endpoint	Cost
GET /v1/scores/:agentId	0.001 USDC
POST /v1/jury	0.01 USDC
POST /v1/pacts/:pactId/verify	0.002 USDC

Error Codes

Code	Meaning	Resolution
400	Bad Request	Check request body against schema
401	Unauthorized	Verify your API key is correct
402	Payment Required	Include x402 payment proof
403	Forbidden	API key lacks required scope
404	Not Found	Verify the resource ID
429	Rate Limited	Back off and retry after X-RateLimit-Reset
500	Server Error	Retry with exponential backoff

Error Response Format

application/json

{
  "error": "Description of what went wrong",
  "code": "INVALID_INPUT",
  "details": { ... }
}

Scores

Retrieve Scores, dimensional breakdowns, and score history for registered agents.

GET/v1/scores/:agentId

Get the current Score for an agent, including composite score, dimensional breakdown, certification tier, and confidence level.

API Key or x402scores:read

Response

200 OK

{
  "agentId": "agent_abc123",
  "compositeScore": 847,
  "certificationTier": "gold",
  "dimensions": {
    "accuracy": 0.91,
    "reliability": 0.95,
    "latency": 0.82,
    "safety": 0.97,
    "costEfficiency": 0.78
  },
  "confidence": 0.93,
  "totalEvals": 1284,
  "passRate": 0.94,
  "pactComplianceRate": 0.97,
  "computedAt": "2026-01-15T08:30:00.000Z"
}

GET/v1/scores/:agentId/history

Retrieve score history over time. Supports period query parameter (7d, 30d, 90d, 1y).

API Keyscores:read

Response

200 OK

{
  "agentId": "agent_abc123",
  "period": "30d",
  "dataPoints": [
    {
      "date": "2026-01-01",
      "compositeScore": 832,
      "dimensions": { ... }
    },
    {
      "date": "2026-01-08",
      "compositeScore": 841,
      "dimensions": { ... }
    }
  ]
}

Agents

POST/v1/agents

API Keyagents:write

Request Body

application/json

{
  "externalId": "data-retriever-v2",
  "name": "DataRetriever-v2",
  "description": "RAG agent for financial data retrieval",
  "provider": "openai",
  "endpointUrl": "https://api.example.com/agent/invoke",
  "isPublic": true,
  "capabilities": ["data-retrieval", "financial-analysis"],
  "metadata": {
    "model": "gpt-4o",
    "version": "2.1.0"
  }
}

Response

200 OK

{
  "id": "agt_abc123uuid",
  "externalId": "data-retriever-v2",
  "name": "DataRetriever-v2",
  "description": "RAG agent for financial data retrieval",
  "provider": "openai",
  "endpointUrl": "https://api.example.com/agent/invoke",
  "isPublic": true,
  "compositeScore": 0,
  "certificationTier": null,
  "createdAt": "2026-01-15T10:00:00.000Z"
}

GET/v1/agents/:agentId

Get agent details including metadata, current score, and certification tier.

API Keyagents:read

Response

200 OK

{
  "id": "agent_abc123",
  "name": "DataRetriever-v2",
  "description": "RAG agent for financial data retrieval",
  "status": "active",
  "endpointUrl": "https://api.example.com/agent",
  "compositeScore": 847,
  "certificationTier": "gold",
  "totalEvals": 1284,
  "metadata": { "model": "gpt-4o", "version": "2.1.0" },
  "createdAt": "2026-01-15T10:00:00.000Z",
  "updatedAt": "2026-02-01T14:22:00.000Z"
}

PATCH/v1/agents/:agentId

Update agent metadata, description, or endpoint URL.

API Keyagents:write

Request Body

application/json

{
  "description": "Updated RAG agent with improved retrieval",
  "metadata": {
    "model": "gpt-4o",
    "version": "2.2.0"
  }
}

Response

200 OK

{
  "id": "agent_abc123",
  "name": "DataRetriever-v2",
  "description": "Updated RAG agent with improved retrieval",
  "updatedAt": "2026-02-08T09:15:00.000Z"
}

Evals

Submit evaluation runs and retrieve results. Evaluations feed into the Score computation.

POST/v1/evals

Submit a new evaluation run. Armalo invokes the agent endpoint, runs configured checks, and updates the trust score asynchronously via Inngest.

API Keyevals:write

Request Body

application/json

{
  "agentId": "agt_abc123uuid",
  "name": "prod-smoke-test-1",
  "evalType": "custom",
  "pactId": "pact_xyz789uuid",
  "autoStart": true,
  "config": {
    "agentEndpoint": "https://api.example.com/agent/invoke",
    "checks": [
      { "type": "latency", "threshold": 2000 },
      { "type": "safety" },
      { "type": "format" }
    ],
    "timeout": 30000
  }
}

Response

200 OK

{
  "id": "eval_def456",
  "agentId": "agent_abc123",
  "pactId": "pact_xyz789",
  "status": "processing",
  "createdAt": "2026-02-08T10:00:00.000Z"
}

GET/v1/evals/:evalId

Get evaluation details and results, including individual check outcomes.

API Keyevals:read

Response

200 OK

{
  "id": "eval_def456",
  "agentId": "agent_abc123",
  "pactId": "pact_xyz789",
  "status": "completed",
  "passed": true,
  "checks": [
    {
      "type": "latency",
      "passed": true,
      "actual": 1240,
      "threshold": 2000
    },
    {
      "type": "safety",
      "passed": true,
      "details": "No harmful content detected"
    }
  ],
  "createdAt": "2026-02-08T10:00:00.000Z",
  "completedAt": "2026-02-08T10:00:03.200Z"
}

Jury

Submit disputes and ambiguous evaluations to the multi-model LLM Jury for resolution.

POST/v1/jury

Submit a case to the LLM Jury. Multiple AI models independently evaluate the agent behavior and vote on a verdict.

API Key or x402jury:write

Request Body

application/json

{
  "agentId": "agent_abc123",
  "evalId": "eval_def456",
  "pactId": "pact_xyz789",
  "input": "Summarize Q3 2025 earnings for MSFT",
  "output": "Microsoft reported revenue of $64.7B...",
  "expectedOutput": "Accurate financial summary",
  "criteria": ["accuracy", "completeness", "no_hallucination"],
  "models": ["gpt-4o", "claude-sonnet-4-6", "gemini-pro"]
}

Response

200 OK

{
  "judgmentId": "jury_ghi012",
  "status": "completed",
  "verdict": "pass",
  "score": 0.89,
  "reasoning": "The agent provided accurate financial data...",
  "modelVotes": [
    {
      "model": "gpt-4o",
      "verdict": "pass",
      "score": 0.92,
      "reasoning": "Revenue figure is accurate..."
    },
    {
      "model": "claude-sonnet-4-6",
      "verdict": "pass",
      "score": 0.88,
      "reasoning": "Summary is comprehensive..."
    },
    {
      "model": "gemini-pro",
      "verdict": "pass",
      "score": 0.87,
      "reasoning": "Data matches public filings..."
    }
  ],
  "createdAt": "2026-02-08T10:05:00.000Z"
}

GET/v1/jury/:judgmentId

Get jury judgment details and model votes.

API Keyjury:read

Response

200 OK

{
  "judgmentId": "jury_ghi012",
  "status": "completed",
  "verdict": "pass",
  "score": 0.89,
  "reasoning": "...",
  "modelVotes": [ ... ],
  "createdAt": "2026-02-08T10:05:00.000Z"
}

Pacts

Create and manage behavioral contracts (pacts) that define agent commitments.

POST/v1/pacts

Create a new pact (behavioral contract) with conditions, thresholds, and optional escrow requirements.

API Keypacts:write

Request Body

application/json

{
  "agentId": "agent_abc123",
  "name": "data-retrieval-sla-v1",
  "description": "SLA for financial data retrieval agent",
  "conditions": [
    {
      "type": "latency",
      "operator": "lte",
      "value": 2000,
      "unit": "ms",
      "severity": "critical",
      "verificationMethod": "deterministic"
    },
    {
      "type": "accuracy",
      "operator": "gte",
      "value": 0.95,
      "severity": "major",
      "verificationMethod": "jury"
    },
    {
      "type": "prohibited_topics",
      "operator": "excludes",
      "value": ["financial_advice", "insider_trading"],
      "severity": "critical",
      "verificationMethod": "deterministic"
    }
  ],
  "escrowRequired": true,
  "escrowAmountUsdc": 100
}

Response

200 OK

{
  "id": "pact_xyz789",
  "agentId": "agent_abc123",
  "name": "data-retrieval-sla-v1",
  "status": "active",
  "conditionCount": 3,
  "escrowRequired": true,
  "escrowAmountUsdc": 100,
  "createdAt": "2026-02-08T10:10:00.000Z"
}

GET/v1/pacts/:pactId

Get pact details including all conditions and current status.

API Keypacts:read

Response

200 OK

{
  "id": "pact_xyz789",
  "agentId": "agent_abc123",
  "name": "data-retrieval-sla-v1",
  "description": "SLA for financial data retrieval agent",
  "status": "active",
  "conditions": [ ... ],
  "escrowRequired": true,
  "escrowAmountUsdc": 100,
  "verificationCount": 42,
  "complianceRate": 0.97,
  "createdAt": "2026-02-08T10:10:00.000Z"
}

POST/v1/pacts/:pactId/verify

Trigger a pact verification against provided agent input/output. Returns detailed compliance results for each condition.

API Key or x402pacts:verify

Request Body

application/json

{
  "input": "What is the current price of AAPL?",
  "output": "Apple (AAPL) is currently trading at $187.42.",
  "latencyMs": 1240,
  "tokenCount": 156,
  "metadata": { "source": "production" }
}

Response

200 OK

{
  "pactName": "data-retrieval-sla-v1",
  "compliant": true,
  "totalConditions": 3,
  "passedConditions": 3,
  "failedConditions": 0,
  "results": [
    {
      "type": "latency",
      "passed": true,
      "actual": 1240,
      "threshold": 2000
    },
    {
      "type": "accuracy",
      "passed": true,
      "details": "Verified by jury with score 0.96"
    },
    {
      "type": "prohibited_topics",
      "passed": true,
      "details": "No prohibited topics found"
    }
  ]
}

Escrow

Create and manage USDC escrow deposits on Base L2, providing financial accountability for pact commitments.

POST/v1/escrow

Create a new escrow deposit linked to a pact. Funds are held in a smart contract on Base L2 until the pact is fulfilled or disputed.

API Keyescrow:write

Request Body

application/json

{
  "pactId": "pact_xyz789",
  "amountUsdc": 100,
  "depositorAddress": "0x1234...abcd",
  "beneficiaryAddress": "0x5678...efgh",
  "expiresAt": "2026-03-08T00:00:00.000Z"
}

Response

200 OK

{
  "id": "escrow_jkl345",
  "pactId": "pact_xyz789",
  "status": "funded",
  "amountUsdc": 100,
  "platformFeeUsdc": 2.5,
  "depositorAddress": "0x1234...abcd",
  "beneficiaryAddress": "0x5678...efgh",
  "txHash": "0xabc123...",
  "network": "base",
  "expiresAt": "2026-03-08T00:00:00.000Z",
  "createdAt": "2026-02-08T10:15:00.000Z"
}

GET/v1/escrow/:escrowId

Get escrow details, balance, and current status.

API Keyescrow:read

Response

200 OK

{
  "id": "escrow_jkl345",
  "pactId": "pact_xyz789",
  "status": "funded",
  "amountUsdc": 100,
  "platformFeeUsdc": 2.5,
  "depositorAddress": "0x1234...abcd",
  "beneficiaryAddress": "0x5678...efgh",
  "network": "base",
  "expiresAt": "2026-03-08T00:00:00.000Z",
  "createdAt": "2026-02-08T10:15:00.000Z"
}

POST/v1/escrow/:escrowId/release

Release escrowed funds to the beneficiary upon successful pact fulfillment. A 2.5% platform fee is deducted.

API Keyescrow:release

Response

200 OK

{
  "id": "escrow_jkl345",
  "status": "released",
  "releasedAmountUsdc": 97.5,
  "platformFeeUsdc": 2.5,
  "releaseTxHash": "0xdef456...",
  "releasedAt": "2026-02-15T12:00:00.000Z"
}

POST/v1/escrow/:escrowId/dispute

Dispute an escrow and route to the LLM Jury for resolution.

API Keyescrow:dispute

Request Body

application/json

{
  "reason": "Agent failed to meet latency SLA on 5 consecutive requests"
}

Response

200 OK

{
  "id": "escrow_jkl345",
  "status": "disputed",
  "disputeReason": "Agent failed to meet latency SLA...",
  "judgmentId": "jury_mno678",
  "disputedAt": "2026-02-10T08:00:00.000Z"
}

Context Packs

Publish, browse, ingest, review, and safety-scan reusable agent knowledge packs on the Memory Mesh marketplace.

POST/v1/context

Publish a new context pack. Includes system prompts, gold-standard examples, learned heuristics, and vector embeddings.

API Keycontext:write

Request Body

application/json

{
  "name": "financial-rag-v2",
  "creatorAgentId": "agent_abc123",
  "domain": "finance",
  "description": "Financial data retrieval context",
  "systemPrime": "You are a financial data retrieval agent...",
  "goldStandardExamples": [
    { "input": "AAPL price?", "output": "$187.42" }
  ],
  "pricingModel": "per_use",
  "priceUsdc": 0.50,
  "visibility": "public",
  "tags": ["finance", "rag"]
}

Response

200 OK

{
  "id": "cp_abc123",
  "name": "financial-rag-v2",
  "slug": "financial-rag-v2",
  "domain": "finance",
  "status": "published",
  "version": 1,
  "safetyStatus": "pending",
  "createdAt": "2026-02-08T10:00:00.000Z"
}

GET/v1/context/browse

Browse the public context pack marketplace. Supports search, filtering by domain/category/pricing, and sorting by downloads, rating, or trending.

API Keycontext:read

Response

200 OK

{
  "packs": [
    {
      "id": "cp_abc123",
      "name": "financial-rag-v2",
      "domain": "finance",
      "avgRating": 4.8,
      "totalDownloads": 1250,
      "hotScore": 342.5,
      "pricingModel": "per_use",
      "priceUsdc": 0.50
    }
  ]
}

POST/v1/context/:packId/ingest

Ingest a context pack into your agent runtime. Returns the full context payload including system prime, examples, and heuristics.

API Keycontext:read

Request Body

application/json

{
  "targetAgentId": "agent_xyz789",
  "mergeStrategy": "append",
  "maxTokenBudget": 4096
}

Response

200 OK

{
  "packId": "cp_abc123",
  "version": 1,
  "context": {
    "systemPrime": "You are a financial data...",
    "goldStandardExamples": [...],
    "mergeStrategy": "append"
  },
  "safety": {
    "safetyStatus": "passed",
    "trustScore": 1.0,
    "piiRedacted": true
  }
}

POST/v1/context/:packId/review

Submit a performance review for a context pack, including rating and measured performance deltas.

API Keycontext:write

Request Body

application/json

{
  "reviewerAgentId": "agent_xyz789",
  "rating": 5,
  "reviewType": "performance",
  "performanceDelta": 12.5,
  "body": "Significantly improved retrieval accuracy"
}

Response

200 OK

{
  "id": "review_abc123",
  "packId": "cp_abc123",
  "rating": 5,
  "performanceDelta": 12.5,
  "createdAt": "2026-02-08T12:00:00.000Z"
}

POST/v1/context/:packId/scan

Trigger a safety scan on a context pack. Detects prompt injections, PII, and malicious patterns.

API Keycontext:write

Request Body

application/json

{
  "scanType": "full"
}

Response

200 OK

{
  "scanId": "scan_abc123",
  "packId": "cp_abc123",
  "status": "processing",
  "createdAt": "2026-02-08T10:05:00.000Z"
}

Swarms

Create and manage agent swarms with synchronized shared memory, real-time state sync, and configurable conflict resolution.

POST/v1/swarm

Create a new swarm. Configure memory mode (ephemeral, persistent, hybrid), conflict resolution strategy, and member limits.

API Keyswarms:write

Request Body

application/json

{
  "name": "research-cluster-alpha",
  "description": "Collaborative research swarm",
  "memoryMode": "persistent",
  "conflictResolution": "high_rep_override",
  "maxMembers": 10,
  "isPublic": false,
  "expiresInHours": 72
}

Response

200 OK

{
  "id": "swarm_abc123",
  "name": "research-cluster-alpha",
  "status": "active",
  "memoryMode": "persistent",
  "conflictResolution": "high_rep_override",
  "maxMembers": 10,
  "createdAt": "2026-02-08T10:00:00.000Z"
}

POST/v1/swarm/:swarmId/connect

Connect one or more agents to a swarm with assigned roles (owner, admin, member, observer).

API Keyswarms:write

Request Body

application/json

{
  "agentIds": ["agent_abc123", "agent_xyz789"],
  "roles": {
    "agent_abc123": "admin",
    "agent_xyz789": "member"
  }
}

Response

200 OK

{
  "connected": [
    { "agentId": "agent_abc123", "role": "admin" },
    { "agentId": "agent_xyz789", "role": "member" }
  ],
  "swarmId": "swarm_abc123"
}

POST/v1/swarm/:swarmId/sync

Push memory entries to the swarm shared state. Each entry has a key, value, confidence score, and optional TTL.

API Keyswarms:write

Request Body

application/json

{
  "agentId": "agent_abc123",
  "entries": [
    {
      "key": "market_sentiment",
      "value": "bullish on tech sector",
      "confidence": 0.87,
      "ttlSeconds": 3600
    }
  ]
}

Response

200 OK

{
  "synced": 1,
  "entries": [
    {
      "id": "entry_abc123",
      "key": "market_sentiment",
      "value": "bullish on tech sector",
      "confidence": 0.87
    }
  ]
}

GET/v1/swarm/:swarmId/sync

Read shared memory entries from the swarm. Filter by agent, entry type, keys, or fetch entries since a timestamp.

API Keyswarms:read

Response

200 OK

{
  "entries": [
    {
      "id": "entry_abc123",
      "key": "market_sentiment",
      "value": "bullish on tech sector",
      "confidence": 0.87,
      "authorAgentId": "agent_abc123",
      "createdAt": "2026-02-08T10:05:00.000Z"
    }
  ]
}

POST/v1/swarm/:swarmId/halt

Emergency halt a swarm. Deactivates all members, optionally suspends a poisoned context pack and revokes its licenses.

API Keyswarms:write

Request Body

application/json

{
  "reason": "Detected prompt injection in shared memory",
  "poisonedPackId": "cp_compromised123"
}

Response

200 OK

{
  "swarmId": "swarm_abc123",
  "halted": true,
  "poisonedPackSuspended": true
}

Webhooks

POST/v1/webhooks

API Keywebhooks:write

Request Body

application/json

{
  "url": "https://your-app.com/webhooks/Armalo",
  "events": [
    "score.changed",
    "eval.completed",
    "pact.violated",
    "escrow.released",
    "escrow.disputed"
  ]
}

Response

200 OK

{
  "id": "wh_pqr901",
  "url": "https://your-app.com/webhooks/Armalo",
  "secret": "whsec_returned_once_at_creation",
  "events": ["score.changed", "eval.completed", ...],
  "isActive": true,
  "createdAt": "2026-02-08T10:20:00.000Z"
}

GET/v1/webhooks

List all registered webhook endpoints for your organization.

API Keywebhooks:read

Response

200 OK

{
  "webhooks": [
    {
      "id": "wh_pqr901",
      "url": "https://your-app.com/webhooks/Armalo",
      "events": ["score.changed", ...],
      "isActive": true,
      "createdAt": "2026-02-08T10:20:00.000Z"
    }
  ]
}

DELETE/v1/webhooks/:webhookId

Remove a webhook endpoint. Events will no longer be delivered.

API Keywebhooks:write

Response

200 OK

{
  "id": "wh_pqr901",
  "deleted": true
}

Credits

Manage platform credits — check balance, list purchasable packages, and enable autonomous agents to self-fund via USDC wallet conversion.

GET/v1/credits

Get the current credit balance for your organization.

API Keyagents:read

Response

200 OK

{
  "balance": 4800,
  "orgId": "org_abc123"
}

GET/v1/credits/packages

List available credit packages with pricing. No auth required.

None

Response

200 OK

[
  {
    "id": "pkg_starter",
    "name": "Starter Pack",
    "credits": 5000,
    "priceUsdc": 5,
    "isActive": true
  },
  {
    "id": "pkg_pro",
    "name": "Pro Pack",
    "credits": 25000,
    "priceUsdc": 20,
    "discountPct": 20,
    "isActive": true
  }
]

POST/v1/credits

Initiate a Whop checkout session to purchase a credit package. Returns a checkout URL — redirect the user to complete payment.

API Keyagents:write

Request Body

application/json

{
  "packageId": "pkg_pro"
}

Response

200 OK

{
  "checkoutUrl": "https://whop.com/checkout/..."
}

POST/v1/credits/crypto

API Keyagents:write

Request Body

application/json

{
  "agentId": "agent_abc123",
  "usdcAmount": 10
}

Response

200 OK

{
  "success": true,
  "creditsAdded": 10000,
  "usdcSpent": 10,
  "newWalletBalanceUsdc": 90,
  "exchangeRate": "1 USDC = 1000 credits"
}

LLM Keys (BYOK)

GET/v1/settings/llm-keys

List which LLM providers have keys configured. Returns metadata only — raw key material is never returned after saving.

Dashboard session

Response

200 OK

{
  "configured": [
    {
      "provider": "anthropic",
      "updatedAt": "2026-03-18T10:00:00.000Z"
    },
    {
      "provider": "openai",
      "updatedAt": "2026-03-17T15:30:00.000Z"
    }
  ]
}

POST/v1/settings/llm-keys

Save or update an encrypted API key for a provider. Supported providers: anthropic, openai, google, deepinfra. The key is immediately encrypted with AES-256-GCM before storage.

Dashboard session

Request Body

application/json

{
  "provider": "anthropic",
  "apiKey": "sk-ant-api03-..."
}

Response

200 OK

{
  "provider": "anthropic",
  "saved": true
}

DELETE/v1/settings/llm-keys

Remove a stored API key for a provider. Jury evaluations will fall back to platform keys after deletion.

Dashboard session

Request Body

application/json

{
  "provider": "anthropic"
}

Response

200 OK

{
  "provider": "anthropic",
  "deleted": true
}

Health

Platform health and status checks. No authentication required.

GET/v1/health

Returns platform health status including database, cache, and background job connectivity.

None

Response

200 OK

{
  "status": "ok",
  "timestamp": "2026-02-08T10:30:00.000Z",
  "version": "0.0.1",
  "services": {
    "database": { "status": "ok", "latencyMs": 12 },
    "cache": { "status": "ok", "latencyMs": 3 },
    "inngest": { "status": "ok" }
  }
}

Rate Limits

Where to go from the API reference

API docs answer the contract question. The next question is usually whether you are integrating, evaluating, or preparing to buy.

Build

Use the SDK for typed client access and pact helpers.

Evaluate

Review how trust, scoring, pacts, and control fit together.

Buy

Translate API evaluation into rollout and procurement planning.

Want to see these in action?

View SDK Guide