aira-sdk 1.0.0 → 2.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +300 -104
- package/dist/client.d.ts +195 -4
- package/dist/client.js +347 -6
- package/dist/extras/index.d.ts +49 -2
- package/dist/extras/index.js +90 -3
- package/dist/extras/langchain.d.ts +69 -18
- package/dist/extras/langchain.js +118 -35
- package/dist/extras/mcp.d.ts +24 -3
- package/dist/extras/mcp.js +70 -9
- package/dist/extras/openai-agents.d.ts +48 -16
- package/dist/extras/openai-agents.js +85 -29
- package/dist/extras/vercel-ai.d.ts +54 -17
- package/dist/extras/vercel-ai.js +104 -30
- package/dist/index.d.ts +1 -1
- package/dist/index.js +5 -1
- package/dist/session.d.ts +15 -4
- package/dist/session.js +11 -3
- package/dist/types.d.ts +197 -20
- package/dist/types.js +26 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -21,42 +21,176 @@ npm install aira-sdk @openai/agents # for OpenAI Agents
|
|
|
21
21
|
|
|
22
22
|
## Quick Start
|
|
23
23
|
|
|
24
|
-
|
|
24
|
+
Aira uses a **two-step flow**: `authorize()` BEFORE the action runs,
|
|
25
|
+
`notarize()` AFTER. This lets you block disallowed actions before they have
|
|
26
|
+
any real-world effect, and still produce a cryptographic receipt once the
|
|
27
|
+
action has completed.
|
|
25
28
|
|
|
26
29
|
```typescript
|
|
27
|
-
import { Aira } from "aira-sdk";
|
|
30
|
+
import { Aira, AiraError } from "aira-sdk";
|
|
28
31
|
|
|
29
32
|
const aira = new Aira({ apiKey: "aira_live_xxx" });
|
|
30
33
|
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
34
|
+
try {
|
|
35
|
+
// Step 1 — ask Aira whether the action is allowed.
|
|
36
|
+
const auth = await aira.authorize({
|
|
37
|
+
actionType: "wire_transfer",
|
|
38
|
+
details: "Send €75K to vendor X",
|
|
39
|
+
agentId: "payments-agent",
|
|
40
|
+
});
|
|
41
|
+
|
|
42
|
+
if (auth.status === "authorized") {
|
|
43
|
+
// Step 2a — execute the action, then notarize the outcome.
|
|
44
|
+
const result = await sendWire(75_000, "vendor");
|
|
45
|
+
await aira.notarize({
|
|
46
|
+
actionId: auth.action_id,
|
|
47
|
+
outcome: "completed",
|
|
48
|
+
outcomeDetails: `Sent. ref=${result.id}`,
|
|
49
|
+
});
|
|
50
|
+
} else if (auth.status === "pending_approval") {
|
|
51
|
+
// Step 2b — enqueue for the approver flow; do NOT execute.
|
|
52
|
+
await queue.enqueue(auth.action_id);
|
|
53
|
+
}
|
|
54
|
+
} catch (e) {
|
|
55
|
+
// Step 2c — a policy denied the action. Nothing to execute, nothing to
|
|
56
|
+
// notarize. POLICY_DENIED is thrown, never returned as a status.
|
|
57
|
+
if (e instanceof AiraError && e.code === "POLICY_DENIED") {
|
|
58
|
+
console.log(`Blocked: ${e.message}`);
|
|
59
|
+
} else {
|
|
60
|
+
throw e;
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
The returned `ActionReceipt` carries the Ed25519 signature and RFC 3161
|
|
66
|
+
timestamp token. If you pass `outcome: "failed"`, the backend still writes
|
|
67
|
+
an audit entry but leaves `signature` / `receipt_id` null.
|
|
68
|
+
|
|
69
|
+
### Reproducibility metadata (replay context)
|
|
70
|
+
|
|
71
|
+
Pass any of the following optional fields to `authorize()` and they're committed in the signed receipt payload (v1.3) and surfaced via `getReplayContext()` so an external replay tool can confirm it has the same inputs as the original run:
|
|
72
|
+
|
|
73
|
+
```typescript
|
|
74
|
+
const auth = await aira.authorize({
|
|
75
|
+
actionType: "tool_call",
|
|
76
|
+
details: "Calling search() with structured input",
|
|
77
|
+
agentId: "research-agent",
|
|
35
78
|
modelId: "claude-sonnet-4-6",
|
|
36
|
-
|
|
79
|
+
// Optional reproducibility metadata
|
|
80
|
+
systemPromptHash: "sha256:a1b2c3...",
|
|
81
|
+
toolInputsHash: "sha256:d4e5f6...",
|
|
82
|
+
modelParams: { temperature: 0.0, top_p: 1.0, seed: 42 },
|
|
83
|
+
executionEnv: {
|
|
84
|
+
sdk_version: "2.0.1",
|
|
85
|
+
framework: "langchain",
|
|
86
|
+
framework_version: "0.3.0",
|
|
87
|
+
},
|
|
37
88
|
});
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
---
|
|
92
|
+
|
|
93
|
+
## Compliance bundles
|
|
94
|
+
|
|
95
|
+
Seal a regulator-ready evidence bundle for a date range. Every receipt in the period is Merkle-rooted, signed, and the export is JWKS-verifiable offline.
|
|
96
|
+
|
|
97
|
+
```typescript
|
|
98
|
+
// Build a Q1 2026 EU AI Act Article 12 evidence packet
|
|
99
|
+
const bundle = await aira.createComplianceBundle({
|
|
100
|
+
framework: "eu_ai_act_art12", // or iso_42001, aiuc_1, soc_2_cc7, raw
|
|
101
|
+
periodStart: "2026-01-01T00:00:00Z",
|
|
102
|
+
periodEnd: "2026-04-01T00:00:00Z",
|
|
103
|
+
title: "Q1 2026 evidence packet",
|
|
104
|
+
agentFilter: ["payments-agent", "support-agent"],
|
|
105
|
+
});
|
|
106
|
+
console.log(bundle.merkle_root, bundle.receipt_count);
|
|
107
|
+
|
|
108
|
+
// Download the self-contained JSON for an auditor
|
|
109
|
+
const exported = await aira.exportComplianceBundle(bundle.id as string);
|
|
110
|
+
// `exported` includes every receipt, the JWKS URL, and a verification recipe.
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
## Drift detection
|
|
114
|
+
|
|
115
|
+
Per-agent behavioral baselines + KL divergence scoring + alerts when an agent's behavior shifts away from its expected pattern.
|
|
116
|
+
|
|
117
|
+
```typescript
|
|
118
|
+
// Compute a baseline from the last 7 days of action history
|
|
119
|
+
const end = new Date();
|
|
120
|
+
const start = new Date(end.getTime() - 7 * 24 * 60 * 60 * 1000);
|
|
121
|
+
|
|
122
|
+
await aira.computeDriftBaseline({
|
|
123
|
+
agentId: "payments-agent",
|
|
124
|
+
windowStart: start.toISOString(),
|
|
125
|
+
windowEnd: end.toISOString(),
|
|
126
|
+
});
|
|
127
|
+
|
|
128
|
+
// Or seed a baseline from a config dict (cold start)
|
|
129
|
+
await aira.seedSyntheticBaseline({
|
|
130
|
+
agentId: "payments-agent",
|
|
131
|
+
expectedDistribution: { wire_transfer: 0.05, email_sent: 0.40, api_call: 0.55 },
|
|
132
|
+
expectedActionsPerDay: 200,
|
|
133
|
+
});
|
|
134
|
+
|
|
135
|
+
// Read-only status check for dashboards
|
|
136
|
+
const status = await aira.getDriftStatus("payments-agent", 24);
|
|
137
|
+
console.log(status.kl_divergence, status.severity);
|
|
38
138
|
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
console.log(
|
|
139
|
+
// Run a check that records an alert if the threshold is exceeded
|
|
140
|
+
const alert = await aira.runDriftCheck("payments-agent");
|
|
141
|
+
if (alert) console.log(`Drift detected: ${alert.severity}`);
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
## Merkle settlement
|
|
145
|
+
|
|
146
|
+
Periodic Merkle anchoring of action receipts. Every receipt eventually gets sealed into exactly one settlement; the settlement's Merkle root is the cryptographic commitment that the batch existed at a specific moment in time.
|
|
147
|
+
|
|
148
|
+
```typescript
|
|
149
|
+
// Admin: seal all unsettled receipts
|
|
150
|
+
const settlement = await aira.createSettlement();
|
|
151
|
+
if (settlement) {
|
|
152
|
+
console.log(settlement.merkle_root, settlement.receipt_count);
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
// An auditor wants to prove a single receipt was in a settlement
|
|
156
|
+
const proof = await aira.getSettlementInclusionProof("rct-abc-123");
|
|
157
|
+
// proof has { merkle_root, leaf_hash, index, leaf_count, siblings }
|
|
158
|
+
// A regulator can verify it offline with a 10-line pure-function walker.
|
|
42
159
|
```
|
|
43
160
|
|
|
44
161
|
---
|
|
45
162
|
|
|
46
163
|
## Core SDK Methods
|
|
47
164
|
|
|
48
|
-
|
|
165
|
+
Every write operation produces a cryptographic receipt.
|
|
49
166
|
|
|
50
167
|
| Category | Method | Description |
|
|
51
168
|
|---|---|---|
|
|
52
|
-
| **Actions** | `
|
|
169
|
+
| **Actions** | `authorize()` | Step 1 — authorize an action BEFORE it runs (throws POLICY_DENIED). Accepts optional replay context fields (`systemPromptHash`, `toolInputsHash`, `modelParams`, `executionEnv`). |
|
|
170
|
+
| | `notarize()` | Step 2 — notarize the outcome, returns Ed25519-signed receipt |
|
|
53
171
|
| | `getAction()` | Retrieve action details + receipt |
|
|
54
172
|
| | `listActions()` | List actions with filters (type, agent, status) |
|
|
55
|
-
| | `
|
|
173
|
+
| | `cosign()` | Human co-signature on a high-stakes action |
|
|
56
174
|
| | `setLegalHold()` | Prevent deletion -- litigation hold |
|
|
57
175
|
| | `releaseLegalHold()` | Release litigation hold |
|
|
58
176
|
| | `getActionChain()` | Chain of custody for an action |
|
|
59
|
-
| | `
|
|
177
|
+
| | `getReplayContext()` | All reproducibility metadata for an action (system prompt hash, tool inputs hash, model params, execution env) |
|
|
178
|
+
| | `verifyAction()` | Public verification -- no auth required. Returns full evidence (signature, public key, signed payload, RFC 3161 token) plus the second-party `policy_evaluator_attestation` for multi-party signing. |
|
|
179
|
+
| **Compliance** | `createComplianceBundle()` | Seal a regulator-ready evidence bundle for a date range. Frameworks: `eu_ai_act_art12`, `iso_42001`, `aiuc_1`, `soc_2_cc7`, `raw`. Merkle-rooted, signed, JWKS-verifiable offline. |
|
|
180
|
+
| | `listComplianceBundles()` | List bundles for the org |
|
|
181
|
+
| | `getComplianceBundle()` | Get bundle metadata |
|
|
182
|
+
| | `exportComplianceBundle()` | Download the self-contained JSON for offline verification |
|
|
183
|
+
| | `getBundleInclusionProof()` | Merkle inclusion proof for one receipt within a bundle |
|
|
184
|
+
| **Drift** | `getDriftStatus()` | Read-only KL divergence + volume ratio against the active baseline |
|
|
185
|
+
| | `computeDriftBaseline()` | Build a baseline from a window of production action history |
|
|
186
|
+
| | `seedSyntheticBaseline()` | Seed a baseline from a config dict (cold start) |
|
|
187
|
+
| | `runDriftCheck()` | Score the current window and persist a `DriftAlert` if it exceeds the threshold |
|
|
188
|
+
| | `listDriftAlerts()` | List drift alerts for an agent |
|
|
189
|
+
| | `acknowledgeDriftAlert()` | Acknowledge an alert |
|
|
190
|
+
| **Settlement** | `createSettlement()` | Seal every unsettled receipt into a Merkle-rooted, signed batch (admin-only) |
|
|
191
|
+
| | `listSettlements()` | List settlements |
|
|
192
|
+
| | `getSettlement()` | Get settlement metadata |
|
|
193
|
+
| | `getSettlementInclusionProof()` | Get a receipt's Merkle inclusion proof from its settlement |
|
|
60
194
|
| **Agents** | `registerAgent()` | Register verifiable agent identity |
|
|
61
195
|
| | `getAgent()` | Retrieve agent profile |
|
|
62
196
|
| | `listAgents()` | List registered agents |
|
|
@@ -165,37 +299,35 @@ console.log(rep.tier); // "Verified"
|
|
|
165
299
|
|
|
166
300
|
### Endpoint Verification
|
|
167
301
|
|
|
168
|
-
Control which external APIs your agents can call. When `endpointUrl` is
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
const receipt = await aira.notarize({
|
|
174
|
-
actionType: "api_call",
|
|
175
|
-
details: "Charged customer $49.99 for subscription renewal",
|
|
176
|
-
agentId: "billing-agent",
|
|
177
|
-
modelId: "claude-sonnet-4-6",
|
|
178
|
-
endpointUrl: "https://api.stripe.com/v1/charges",
|
|
179
|
-
});
|
|
180
|
-
```
|
|
181
|
-
|
|
182
|
-
#### Handle ENDPOINT_NOT_WHITELISTED
|
|
302
|
+
Control which external APIs your agents can call. When `endpointUrl` is
|
|
303
|
+
passed to `authorize()`, Aira checks it against your org's whitelist
|
|
304
|
+
before returning. Unrecognized endpoints throw `ENDPOINT_NOT_WHITELISTED`
|
|
305
|
+
in strict mode — the action is never authorized and you never need to
|
|
306
|
+
call `notarize()`.
|
|
183
307
|
|
|
184
308
|
```typescript
|
|
185
309
|
import { Aira, AiraError } from "aira-sdk";
|
|
186
310
|
|
|
187
311
|
try {
|
|
188
|
-
const
|
|
312
|
+
const auth = await aira.authorize({
|
|
189
313
|
actionType: "api_call",
|
|
190
|
-
details: "
|
|
191
|
-
agentId: "
|
|
192
|
-
|
|
314
|
+
details: "Charged customer $49.99 for subscription renewal",
|
|
315
|
+
agentId: "billing-agent",
|
|
316
|
+
modelId: "claude-sonnet-4-6",
|
|
317
|
+
endpointUrl: "https://api.stripe.com/v1/charges",
|
|
193
318
|
});
|
|
319
|
+
|
|
320
|
+
if (auth.status === "authorized") {
|
|
321
|
+
const result = await stripe.charges.create({ amount: 4999, /* ... */ });
|
|
322
|
+
await aira.notarize({
|
|
323
|
+
actionId: auth.action_id,
|
|
324
|
+
outcome: "completed",
|
|
325
|
+
outcomeDetails: `Charged ${result.id}`,
|
|
326
|
+
});
|
|
327
|
+
}
|
|
194
328
|
} catch (e) {
|
|
195
329
|
if (e instanceof AiraError && e.code === "ENDPOINT_NOT_WHITELISTED") {
|
|
196
330
|
console.log(`Blocked: ${e.message}`);
|
|
197
|
-
console.log(`Approval request: ${e.details.approval_id}`);
|
|
198
|
-
console.log(`Suggested pattern: ${e.details.url_pattern_suggested}`);
|
|
199
331
|
} else {
|
|
200
332
|
throw e;
|
|
201
333
|
}
|
|
@@ -225,68 +357,90 @@ const handler = new AiraCallbackHandler(aira, "research-agent", {
|
|
|
225
357
|
|
|
226
358
|
## Session
|
|
227
359
|
|
|
228
|
-
Pre-fill defaults for a block of related actions. Every `
|
|
360
|
+
Pre-fill defaults for a block of related actions. Every `authorize()` call
|
|
361
|
+
within the session inherits the agent identity, producing receipts that
|
|
362
|
+
share a common provenance chain.
|
|
229
363
|
|
|
230
364
|
```typescript
|
|
231
365
|
const sess = aira.session("onboarding-agent", { modelId: "claude-sonnet-4-6" });
|
|
232
366
|
|
|
233
|
-
|
|
234
|
-
await sess.
|
|
235
|
-
|
|
367
|
+
async function notarize(actionType: string, details: string) {
|
|
368
|
+
const auth = await sess.authorize({ actionType, details });
|
|
369
|
+
if (auth.status === "authorized") {
|
|
370
|
+
await sess.notarize({ actionId: auth.action_id, outcome: "completed" });
|
|
371
|
+
}
|
|
372
|
+
}
|
|
373
|
+
|
|
374
|
+
await notarize("identity_verified", "Verified customer ID #4521");
|
|
375
|
+
await notarize("account_created", "Created account for customer #4521");
|
|
376
|
+
await notarize("welcome_sent", "Sent welcome email to customer #4521");
|
|
236
377
|
```
|
|
237
378
|
|
|
238
379
|
---
|
|
239
380
|
|
|
240
381
|
## Offline Mode
|
|
241
382
|
|
|
242
|
-
Queue
|
|
383
|
+
Queue `authorize()` calls locally when connectivity is unavailable. On
|
|
384
|
+
`sync()`, the backend runs the real authorizations and returns their
|
|
385
|
+
results. The agent can then call `notarize()` per action to close the loop.
|
|
243
386
|
|
|
244
387
|
```typescript
|
|
245
388
|
const aira = new Aira({ apiKey: "aira_live_xxx", offline: true });
|
|
246
389
|
|
|
247
390
|
// These queue locally — no network calls
|
|
248
|
-
await aira.
|
|
249
|
-
await aira.
|
|
391
|
+
await aira.authorize({ actionType: "scan_completed", details: "Scanned document batch #77" });
|
|
392
|
+
await aira.authorize({ actionType: "classification_done", details: "Classified 142 documents" });
|
|
250
393
|
|
|
251
394
|
console.log(aira.pendingCount); // 2
|
|
252
395
|
|
|
253
|
-
// Flush to API when back online —
|
|
396
|
+
// Flush to the API when back online — returns the Authorization for each
|
|
397
|
+
// queued request. Use the action_ids to notarize outcomes afterwards.
|
|
254
398
|
const results = await aira.sync();
|
|
255
399
|
```
|
|
256
400
|
|
|
401
|
+
Offline mode is intended for actions the agent will execute regardless of
|
|
402
|
+
Aira's decision (sensor reads, local scans). For actions whose execution
|
|
403
|
+
depends on the authorization result, run the SDK online.
|
|
404
|
+
|
|
257
405
|
---
|
|
258
406
|
|
|
259
407
|
## Human Approval
|
|
260
408
|
|
|
261
|
-
Hold high-stakes actions for human review before
|
|
409
|
+
Hold high-stakes actions for human review before they execute. Approvers
|
|
410
|
+
receive an email with Approve/Deny buttons. If the action is held, the SDK
|
|
411
|
+
returns `status: "pending_approval"` from `authorize()` and the agent must
|
|
412
|
+
enqueue the `action_id` instead of executing.
|
|
262
413
|
|
|
263
414
|
```typescript
|
|
264
|
-
const
|
|
415
|
+
const auth = await aira.authorize({
|
|
265
416
|
actionType: "loan_decision",
|
|
266
|
-
details: "
|
|
417
|
+
details: "Approve €15,000 loan for Maria Schmidt",
|
|
267
418
|
agentId: "lending-agent",
|
|
268
419
|
requireApproval: true,
|
|
269
420
|
approvers: ["compliance@acme.com", "risk@acme.com"],
|
|
270
421
|
});
|
|
271
|
-
console.log(receipt.status); // "pending_approval"
|
|
272
|
-
console.log(receipt.receipt_id); // undefined — no receipt until approved
|
|
273
422
|
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
requireApproval: true,
|
|
280
|
-
});
|
|
423
|
+
if (auth.status === "pending_approval") {
|
|
424
|
+
// Do NOT execute the action. Store action_id and wait for the
|
|
425
|
+
// action.approved webhook, then execute + notarize.
|
|
426
|
+
await queue.enqueue(auth.action_id);
|
|
427
|
+
}
|
|
281
428
|
```
|
|
282
429
|
|
|
283
|
-
The approver clicks "Approve" in the email →
|
|
430
|
+
The approver clicks "Approve" in the email → the action transitions to
|
|
431
|
+
`authorized` → `action.approved` webhook fires → your handler executes the
|
|
432
|
+
action and calls `aira.notarize({ actionId, outcome: "completed" })`.
|
|
284
433
|
|
|
285
|
-
Configure default approvers in the [dashboard](https://app.airaproof.com/dashboard/settings/approvers)
|
|
434
|
+
Configure default approvers in the [dashboard](https://app.airaproof.com/dashboard/settings/approvers).
|
|
286
435
|
|
|
287
436
|
### Automatic Policy Evaluation
|
|
288
437
|
|
|
289
|
-
Org admins configure policies in the dashboard — your code doesn't change.
|
|
438
|
+
Org admins configure policies in the dashboard — your code doesn't change.
|
|
439
|
+
Every `authorize()` call is automatically evaluated against active policies
|
|
440
|
+
before returning. If a policy denies the action, the SDK throws
|
|
441
|
+
`AiraError` with code `POLICY_DENIED` and the action is never persisted as
|
|
442
|
+
authorized. If a policy forces human review, `status` is
|
|
443
|
+
`pending_approval`. Otherwise `status` is `authorized`.
|
|
290
444
|
|
|
291
445
|
Three evaluation modes:
|
|
292
446
|
|
|
@@ -295,21 +449,15 @@ Three evaluation modes:
|
|
|
295
449
|
- **Consensus**: Multiple LLMs evaluate independently — disagreement triggers human review (3-10s)
|
|
296
450
|
|
|
297
451
|
```typescript
|
|
298
|
-
// Your code stays the same — policies evaluate automatically
|
|
299
|
-
const receipt = await aira.notarize({
|
|
300
|
-
actionType: "wire_transfer",
|
|
301
|
-
details: "Transfer $50,000 to vendor account",
|
|
302
|
-
agentId: "billing-agent",
|
|
303
|
-
});
|
|
304
|
-
|
|
305
|
-
// If a policy triggers "require_approval":
|
|
306
|
-
console.log(receipt.status); // "pending_approval"
|
|
307
|
-
console.log(receipt.policy_evaluation); // { policy_name: "Wire transfers need approval", decision: "require_approval", ... }
|
|
308
|
-
|
|
309
|
-
// If a policy triggers "deny":
|
|
310
452
|
import { AiraError } from "aira-sdk";
|
|
453
|
+
|
|
311
454
|
try {
|
|
312
|
-
await aira.
|
|
455
|
+
const auth = await aira.authorize({
|
|
456
|
+
actionType: "data_deletion",
|
|
457
|
+
details: "Delete customer records",
|
|
458
|
+
agentId: "support-agent",
|
|
459
|
+
});
|
|
460
|
+
// ... execute + notarize ...
|
|
313
461
|
} catch (e) {
|
|
314
462
|
if (e instanceof AiraError && e.code === "POLICY_DENIED") {
|
|
315
463
|
console.log(e.message); // "Action denied by policy 'Block deletions': ..."
|
|
@@ -317,87 +465,129 @@ try {
|
|
|
317
465
|
}
|
|
318
466
|
```
|
|
319
467
|
|
|
320
|
-
Every policy evaluation produces a cryptographic receipt — proof the policy was checked. The SDK `requireApproval: true` override still works and skips policy evaluation entirely.
|
|
321
|
-
|
|
322
468
|
Configure policies at [Settings → Policies](https://app.airaproof.com/dashboard/policies).
|
|
323
469
|
|
|
324
470
|
---
|
|
325
471
|
|
|
326
472
|
## Framework Integrations
|
|
327
473
|
|
|
328
|
-
Drop Aira into your existing agent framework with one import:
|
|
474
|
+
Drop Aira into your existing agent framework with one import. Every integration is honestly labeled as one of three kinds:
|
|
329
475
|
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
|
476
|
+
- **gate** — intercepts before execution and can deny. The action is authorized through Aira's policy engine *before* the framework runs the underlying call. Denied actions never run.
|
|
477
|
+
- **audit** — runs after execution because the host framework does not expose a pre-execution hook that can abort. Aira still records a signed receipt; it just cannot prevent the action.
|
|
478
|
+
- **adapter** — exposes Aira's own API as a tool the host framework can call. Neither a gate nor an audit hook over other tools.
|
|
479
|
+
|
|
480
|
+
We ship fewer integrations than some competitors and label every one of them honestly. The integration matrix is generated from `INTEGRATIONS` in `aira-sdk/extras` — the docs cannot drift from the code.
|
|
481
|
+
|
|
482
|
+
| Integration | Import | Type | Pre-execution gate? | Surface | Notes |
|
|
483
|
+
|---|---|---|---|---|---|
|
|
484
|
+
| **LangChain.js** | `aira-sdk/extras/langchain` | gate | Yes (tools); No (chains/LLMs) | `AiraCallbackHandler` | `handleToolStart` calls `authorize()` and throws on `POLICY_DENIED` so the tool never runs. Chain/LLM hooks are post-hoc because LangChain has no pre-execution chain hook that can abort. |
|
|
485
|
+
| **Vercel AI SDK** | `aira-sdk/extras/vercel-ai` | gate | Yes (`wrapTool`); No (`onFinish`) | `AiraVercelMiddleware` | `wrapTool()` wraps the tool's `execute` so `authorize()` runs before the tool body. `onStepFinish` / `onFinish` callbacks are explicitly labeled audit-only. |
|
|
486
|
+
| **OpenAI Agents** | `aira-sdk/extras/openai-agents` | gate | Yes | `AiraGuardrail.wrapTool()` | Wraps each tool function: `authorize()` runs before the tool body. Denied calls throw; failed calls notarize with `outcome="failed"`. |
|
|
487
|
+
| **MCP** | `aira-sdk/extras/mcp` | adapter | N/A | `createServer()` | MCP is bidirectional: the agent CHOOSES to call `authorize_action` / `notarize_action`. Not a wrapper over other MCP tools — it's a protocol adapter. |
|
|
488
|
+
| **Webhooks** | `aira-sdk/extras/webhooks` | adapter | N/A | `verifySignature()` | Standalone HMAC-SHA256 webhook signature verifier. Not an agent integration. |
|
|
337
489
|
|
|
338
490
|
### LangChain.js
|
|
339
491
|
|
|
340
|
-
`AiraCallbackHandler`
|
|
492
|
+
`AiraCallbackHandler` runs the two-step flow on every tool, chain, and LLM
|
|
493
|
+
event. The `Start` callbacks call `authorize()` — if a policy denies the
|
|
494
|
+
action or flags it for human review, LangChain aborts the step. The `End`
|
|
495
|
+
and `Error` callbacks call `notarize()` with the appropriate outcome. This
|
|
496
|
+
is a **real authorization gate**, not just post-hoc audit logging.
|
|
341
497
|
|
|
342
498
|
```typescript
|
|
343
499
|
import { Aira } from "aira-sdk";
|
|
344
500
|
import { AiraCallbackHandler } from "aira-sdk/extras/langchain";
|
|
345
501
|
|
|
346
502
|
const aira = new Aira({ apiKey: "aira_live_xxx" });
|
|
347
|
-
const handler = new AiraCallbackHandler(
|
|
503
|
+
const handler = new AiraCallbackHandler(aira, "research-agent", {
|
|
504
|
+
modelId: "gpt-5.2",
|
|
505
|
+
strict: false, // fail-open on network errors; set true to fail-closed
|
|
506
|
+
});
|
|
348
507
|
|
|
349
|
-
|
|
350
|
-
|
|
508
|
+
const result = await chain.invoke(
|
|
509
|
+
{ input: "Analyze Q1 revenue" },
|
|
510
|
+
{ callbacks: [handler.asCallbacks()] },
|
|
511
|
+
);
|
|
351
512
|
```
|
|
352
513
|
|
|
353
514
|
### Vercel AI
|
|
354
515
|
|
|
355
|
-
`AiraVercelMiddleware`
|
|
516
|
+
`AiraVercelMiddleware` exposes two integration points:
|
|
517
|
+
|
|
518
|
+
- **`wrapTool()`** — the real authorization gate. Calls `authorize()`
|
|
519
|
+
before the tool runs, notarizes the outcome afterwards. Use this for any
|
|
520
|
+
tool that touches the outside world.
|
|
521
|
+
- **`onStepFinish` / `onFinish`** — post-hoc audit callbacks. These fire
|
|
522
|
+
after the step has run and cannot gate execution. Useful for logging
|
|
523
|
+
generation metadata.
|
|
356
524
|
|
|
357
525
|
```typescript
|
|
358
526
|
import { Aira } from "aira-sdk";
|
|
359
527
|
import { AiraVercelMiddleware } from "aira-sdk/extras/vercel-ai";
|
|
528
|
+
import { tool } from "ai";
|
|
529
|
+
import { z } from "zod";
|
|
360
530
|
|
|
361
531
|
const aira = new Aira({ apiKey: "aira_live_xxx" });
|
|
362
|
-
const middleware = new AiraVercelMiddleware(
|
|
532
|
+
const middleware = new AiraVercelMiddleware(aira, "assistant-agent");
|
|
533
|
+
|
|
534
|
+
const webSearch = tool({
|
|
535
|
+
description: "Search the web",
|
|
536
|
+
parameters: z.object({ query: z.string() }),
|
|
537
|
+
execute: middleware.wrapTool(async ({ query }) => {
|
|
538
|
+
return await search(query);
|
|
539
|
+
}, "web_search"),
|
|
540
|
+
});
|
|
363
541
|
|
|
364
|
-
|
|
365
|
-
const result = await middleware.wrapGenerateText({
|
|
542
|
+
const result = await generateText({
|
|
366
543
|
model: openai("gpt-5.2"),
|
|
367
|
-
prompt: "
|
|
544
|
+
prompt: "Find today's EU AI Act news",
|
|
545
|
+
tools: { webSearch },
|
|
546
|
+
...middleware.asCallbacks(),
|
|
368
547
|
});
|
|
369
548
|
```
|
|
370
549
|
|
|
371
550
|
### OpenAI Agents SDK
|
|
372
551
|
|
|
373
|
-
`AiraGuardrail`
|
|
552
|
+
`AiraGuardrail.wrapTool()` gates every tool invocation through Aira's
|
|
553
|
+
two-step flow: `authorize()` runs first and can block the tool on
|
|
554
|
+
`POLICY_DENIED` or `pending_approval`, then `notarize()` closes the loop
|
|
555
|
+
after the tool returns. Only tool names and arg keys are sent — raw user
|
|
556
|
+
input stays in your process.
|
|
374
557
|
|
|
375
558
|
```typescript
|
|
376
559
|
import { Aira } from "aira-sdk";
|
|
377
560
|
import { AiraGuardrail } from "aira-sdk/extras/openai-agents";
|
|
378
561
|
|
|
379
562
|
const aira = new Aira({ apiKey: "aira_live_xxx" });
|
|
380
|
-
const guardrail = new AiraGuardrail(
|
|
563
|
+
const guardrail = new AiraGuardrail(aira, "assistant-agent");
|
|
381
564
|
|
|
382
|
-
|
|
383
|
-
const
|
|
384
|
-
const execute = guardrail.wrapTool(codeExecutor, { toolName: "code_exec" });
|
|
565
|
+
const search = guardrail.wrapTool(searchTool, "web_search");
|
|
566
|
+
const execute = guardrail.wrapTool(codeExecutor, "code_exec");
|
|
385
567
|
```
|
|
386
568
|
|
|
387
569
|
---
|
|
388
570
|
|
|
389
571
|
## MCP Server
|
|
390
572
|
|
|
391
|
-
Expose Aira as an MCP tool server. Any MCP-compatible AI agent can
|
|
573
|
+
Expose Aira as an MCP tool server. Any MCP-compatible AI agent can run the
|
|
574
|
+
two-step flow and verify receipts without a direct SDK dependency.
|
|
392
575
|
|
|
393
576
|
```typescript
|
|
577
|
+
import { Aira } from "aira-sdk";
|
|
394
578
|
import { createServer } from "aira-sdk/extras/mcp";
|
|
395
579
|
|
|
396
|
-
const
|
|
397
|
-
|
|
580
|
+
const aira = new Aira({ apiKey: "aira_live_xxx" });
|
|
581
|
+
const { listTools, callTool } = createServer(aira);
|
|
582
|
+
// Wire into @modelcontextprotocol/sdk's Server.
|
|
398
583
|
```
|
|
399
584
|
|
|
400
|
-
The server exposes
|
|
585
|
+
The server exposes the two-step flow as explicit tools:
|
|
586
|
+
`authorize_action`, `notarize_action`, `get_action`, `verify_action`,
|
|
587
|
+
`get_receipt`, plus trust-layer helpers. An MCP client is expected to call
|
|
588
|
+
`authorize_action` before performing a side effect and `notarize_action`
|
|
589
|
+
after — the MCP protocol has no hidden hook point, so the authorization
|
|
590
|
+
gate only exists if the agent cooperates with the contract.
|
|
401
591
|
|
|
402
592
|
Add to your MCP client config:
|
|
403
593
|
|
|
@@ -447,17 +637,23 @@ Supported event types: `action.notarized`, `action.authorized`, `agent.registere
|
|
|
447
637
|
import { Aira, AiraError } from "aira-sdk";
|
|
448
638
|
|
|
449
639
|
try {
|
|
450
|
-
await aira.
|
|
640
|
+
const auth = await aira.authorize({ actionType: "test", details: "test" });
|
|
641
|
+
// ...
|
|
451
642
|
} catch (e) {
|
|
452
643
|
if (e instanceof AiraError) {
|
|
453
|
-
console.log(e.status); //
|
|
454
|
-
console.log(e.code); // "
|
|
455
|
-
console.log(e.message);
|
|
644
|
+
console.log(e.status); // e.g. 403
|
|
645
|
+
console.log(e.code); // e.g. "POLICY_DENIED"
|
|
646
|
+
console.log(e.message);
|
|
456
647
|
}
|
|
457
648
|
}
|
|
458
649
|
```
|
|
459
650
|
|
|
460
|
-
|
|
651
|
+
Framework integrations (LangChain.js, Vercel AI, OpenAI Agents) **fail open
|
|
652
|
+
by default** on transient errors (network, 5xx) — a warning is logged and
|
|
653
|
+
the tool still runs. `POLICY_DENIED` and `pending_approval` always
|
|
654
|
+
propagate as thrown errors so disallowed actions are never executed. Pass
|
|
655
|
+
`strict: true` to the integration constructor to fail closed on transient
|
|
656
|
+
errors too.
|
|
461
657
|
|
|
462
658
|
---
|
|
463
659
|
|