lago-agent-sdk
v0.2.0
Published
Instrument LLM clients and emit usage events to Lago.
Maintainers
Readme
lago-agent-sdk
Instrument LLM clients and emit usage events to Lago for billing.
Authored in TypeScript, ships compiled JavaScript with .d.ts — works for both JS and TS consumers.
┌──────────────┐
your code ──────► │ wrapped client│ ──► provider (Bedrock / Mistral / …)
└──────┬───────┘
│ (extract usage)
▼
┌──────────────┐
│ Lago events │ ──► api.getlago.com
└──────────────┘What it does
- Wraps your existing LLM client in place — no API surface change for your application code.
- Extracts usage from each response into a normalized shape (
CanonicalUsage). - Buffers events in memory, flushes them in batches to Lago's
/events/batchendpoint. - Survives provider/Lago outages with exponential backoff and a bounded buffer.
- p99 wrap-overhead under 5 ms — your call is never blocked on Lago.
Install
npm install lago-agent-sdk
# plus the provider SDK(s) you use:
npm install @aws-sdk/client-bedrock-runtime
npm install @anthropic-ai/sdk
npm install @mistralai/mistralai
npm install openai
npm install @google/genaiQuickstart — Bedrock
import { BedrockRuntimeClient, ConverseCommand } from "@aws-sdk/client-bedrock-runtime";
import { LagoSDK } from "lago-agent-sdk";
const sdk = new LagoSDK({
apiKey: process.env.LAGO_API_KEY!,
defaultSubscriptionId: "sub_acme",
});
const client = sdk.wrap(new BedrockRuntimeClient({ region: "eu-west-1" }));
await client.send(new ConverseCommand({
modelId: "eu.amazon.nova-lite-v1:0",
messages: [{ role: "user", content: [{ text: "Hello" }] }],
}));
await sdk.flush();The wrapped client behaves identically to the original — same arguments, same return shape, same exceptions. The SDK adds an in-memory queue that batches events to Lago in the background.
Quickstart — Anthropic
import Anthropic from "@anthropic-ai/sdk";
import { LagoSDK } from "lago-agent-sdk";
const sdk = new LagoSDK({ apiKey: process.env.LAGO_API_KEY!, defaultSubscriptionId: "sub_acme" });
const client = sdk.wrap(new Anthropic({ apiKey: process.env.ANTHROPIC_API_KEY! }));
await client.messages.create({
model: "claude-sonnet-4-6",
max_tokens: 200,
messages: [{ role: "user", content: "Hello" }],
});
await sdk.flush();Both messages.create({ ..., stream: true }) and the messages.stream(...) helper (with .finalMessage()) are instrumented automatically.
Quickstart — Mistral
import { Mistral } from "@mistralai/mistralai";
import { LagoSDK } from "lago-agent-sdk";
const sdk = new LagoSDK({ apiKey: process.env.LAGO_API_KEY!, defaultSubscriptionId: "sub_acme" });
const client = sdk.wrap(new Mistral({ apiKey: process.env.MISTRAL_API_KEY! }));
await client.chat.complete({
model: "mistral-small-latest",
messages: [{ role: "user", content: "Hello" }],
});
await sdk.flush();Quickstart — OpenAI
import OpenAI from "openai";
import { LagoSDK } from "lago-agent-sdk";
const sdk = new LagoSDK({ apiKey: process.env.LAGO_API_KEY!, defaultSubscriptionId: "sub_acme" });
const client = sdk.wrap(new OpenAI({ apiKey: process.env.OPENAI_API_KEY! }));
await client.chat.completions.create({
model: "gpt-4o-mini",
messages: [{ role: "user", content: "Hello" }],
max_completion_tokens: 200,
});
await sdk.flush();Covers both Chat Completions (client.chat.completions.create) and the newer Responses API (client.responses.create), sync + streaming. For Chat Completions streaming, the wrapper auto-injects stream_options: { include_usage: true } so the final chunk carries usage data — without it OpenAI emits no usage on streamed responses.
Reasoning tokens (llm_reasoning_tokens) populate automatically when you call an o-series model (o4-mini, o1, etc.) — OpenAI is the first provider to expose this metric separately.
Quickstart — Gemini
import { GoogleGenAI } from "@google/genai";
import { LagoSDK } from "lago-agent-sdk";
const sdk = new LagoSDK({ apiKey: process.env.LAGO_API_KEY!, defaultSubscriptionId: "sub_acme" });
const client = sdk.wrap(new GoogleGenAI({ apiKey: process.env.GEMINI_API_KEY! }));
await client.models.generateContent({
model: "gemini-2.5-flash",
contents: "Hello",
});
await sdk.flush();Wraps the modern @google/genai SDK. Covers client.models.generateContent + generateContentStream, sync + streaming. Reads usage from response.usageMetadata (both camelCase and snake_case forms supported).
Reasoning tokens populate automatically on Gemini 2.5 — the model reasons internally by default and surfaces thoughtsTokenCount. Note the semantic difference vs OpenAI:
- OpenAI:
reasoning_tokensis a subset ofcompletion_tokens(already counted in output) - Gemini:
thoughtsTokenCountis additive tocandidatesTokenCount(total Google bill = output + reasoning)
Multi-tenant — pick a subscription per call
Three ways to set the external_subscription_id, in priority order:
// 1. Per-call override — attach __lago to a Bedrock command, or pass `lago: {...}` on a Mistral call.
const cmd = new ConverseCommand({...});
(cmd as any).__lago = { subscription: "sub_acme", dimensions: { feature: "summarize" } };
await client.send(cmd);
// 2. Context-bound — uses AsyncLocalStorage; safe across `await` boundaries.
sdk.withSubscription("sub_acme", async () => {
await client.send(...); // bills sub_acme
});
// or at the top of a request handler:
sdk.setSubscription("sub_acme");
// 3. Default at init (fallback)
new LagoSDK({ apiKey: "...", defaultSubscriptionId: "sub_default" });Backed by Node's AsyncLocalStorage for safe propagation across promises.
Supported providers
| Provider | Access | Status |
|---|---|---|
| AWS Bedrock | ConverseCommand (sync + stream) | ✓ |
| AWS Bedrock | InvokeModelCommand (sync + stream), 7 model families | ✓ |
| Anthropic | @anthropic-ai/sdk (messages.create sync + stream, messages.stream) | ✓ |
| Mistral | @mistralai/mistralai (chat.complete + chat.stream) | ✓ |
| OpenAI | openai (chat.completions.create + responses.create, sync + async + stream) | ✓ |
| Google Gemini | @google/genai (models.generateContent + generateContentStream, sync + stream) | ✓ |
| Vercel AI SDK | wrapLanguageModel middleware | Phase 4 |
Token dimensions captured
CanonicalUsage carries 11 numeric fields. Which ones populate depends on the provider:
| Field | Lago metric code | Bedrock | Anthropic | Mistral | OpenAI | Gemini |
|---|---|---|---|---|---|---|
| input | llm_input_tokens | ✓ | ✓ | ✓ | ✓ | ✓ |
| output | llm_output_tokens | ✓ | ✓ | ✓ | ✓ | ✓ |
| cache_read | llm_cached_input_tokens | ✓ (Anthropic) | ✓ | ✓ (when cache hits) | ✓ (auto-cache) | ✓ (CachedContent API) |
| cache_write | llm_cache_creation_tokens | ✓ (Anthropic) | ✓ | ✗ | ✗ | ✗ |
| cache_write_5m / 1h | llm_cache_write_5m/1h_tokens | ✓ (Anthropic InvokeModel) | ✓ | ✗ | ✗ | ✗ |
| reasoning | llm_reasoning_tokens | ✗ (folded into output) | ✗ (folded into output) | ✗ (folded into output) | ✓ (o-series, subset) | ✓ (Gemini 2.5, additive) |
| tool_calls | llm_tool_calls | ✓ | ✓ | ✓ | ✓ | ✓ |
| audio_input | llm_audio_input_tokens | ✗ | ✗ | ✗ | ✓ (GPT-4o-audio) | ✓ (multimodal AUDIO) |
| audio_output | llm_audio_output_tokens | ✗ | ✗ | ✗ | ✓ (GPT-4o-audio) | ✓ (multimodal AUDIO) |
| image_input | llm_image_input_tokens | ✗ | ✗ | ✗ | ✗ (Phase 3) | ✓ (multimodal IMAGE) |
Semantic note on reasoning:
- OpenAI's
reasoning_tokensis a SUBSET ofoutput— already counted incompletion_tokens. - Gemini's
thoughtsTokenCountis ADDITIVE tooutput—candidates + thoughts = total billable output.
Semantic note on input breakdowns (avoid double-counting):
For both OpenAI and Gemini, cache_read, audio_input, and image_input are subsets of input, not additive to it — they are a breakdown of tokens already counted in llm_input_tokens. For example, OpenAI reports cached_tokens under prompt_tokens_details within prompt_tokens, and Gemini's docs state promptTokenCount "includes the number of tokens in the cached content". A billable metric that sums llm_input_tokens + llm_cached_input_tokens (or + llm_audio_input_tokens, + llm_image_input_tokens) will double-count. Bill on llm_input_tokens as the total; use the breakdown fields only for cost attribution or discounted-rate tiers (e.g. cached input billed at a lower rate), subtracting them from input rather than adding.
Pricing mode — send dollar cost instead of tokens
By default the SDK emits token counts (pricingMode: "tokens"). You can instead have it
compute and emit the dollar cost of each call: Σ(unit_price_per_token × tokens) × markup.
const sdk = new LagoSDK({
apiKey: "...",
defaultSubscriptionId: "sub_123",
config: {
pricingMode: "price", // "tokens" (default) | "price"
markup: 1.2, // optional cost multiplier (1.2 = +20%)
},
});
const client = sdk.wrap(anthropicClient);In price mode the SDK emits one event per call with code llm_cost. The event carries a
top-level precise_total_amount_cents (total cost in cents, after markup) for Lago's dynamic
charge model, plus a breakdown in properties: unit (total tokens), value (USD total),
base_cost (pre-markup), markup, price_source, and per-field *_tokens / *_unit_price /
*_cost. Set up in Lago a sum-aggregation billable metric llm_cost on field_name: "unit"
and a dynamic charge on it — Lago sums each event's precise_total_amount_cents into a
single fee (unit is the displayed usage quantity).
Per-call override via the inline lago option (Bedrock: the command's __lago):
await client.messages.create({
model: "claude-...",
messages: [...],
lago: { mode: "price", markup: 1.5 },
} as any);Live, public pricing sources (no API keys): OpenRouter (/api/v1/models) for native
anthropic/openai/mistral/gemini clients, and the AWS Bedrock Price List Bulk API for
Bedrock. Prices are fetched + cached in the background (TTL pricingTtlMs, default 1h) on the
queue loop, so your LLM call is never blocked on pricing.
Fallback (never under-bill): if a price is unavailable (table not warm on the first call,
or the model isn't found), the SDK falls back to emitting token-count events and calls
onError — it never silently drops the usage.
Bedrock note: AWS's public bulk data lists many models (Titan, Llama, Mistral, Cohere, and older Claude) but, at time of writing, not the current Claude 3.5/3.7/4 models. Bedrock calls for models absent from AWS's data fall back to token events. Native Anthropic clients are priced via OpenRouter and unaffected.
Error policy
The SDK never breaks your LLM call. If anything in instrumentation fails (adapter bug, Lago down, network error), the SDK swallows it, logs a warning, and your call returns normally.
Wire your own observability via onError:
new LagoSDK({
apiKey: "...",
config: {
onError: (err, where) => Sentry.captureException(err, { tags: { sdk_phase: where } }),
},
});Setting up Lago
The SDK ships with default metric codes (llm_input_tokens, llm_output_tokens, etc.). You need to register matching billable metrics in your Lago tenant before events count toward charges. See Lago docs — Billable Metrics.
Development
git clone https://github.com/getlago/lago-agent-sdk-js
cd lago-agent-sdk-js
npm install
npm test
npm run buildRun live integration tests (requires real credentials):
AWS_BEARER_TOKEN_BEDROCK="..." \
MISTRAL_API_KEY="..." \
LAGO_API_URL="https://api.getlago.com/api/v1/" \
LAGO_API_KEY="..." \
LAGO_EXTERNAL_SUBSCRIPTION_ID="sub_..." \
npm test -- tests/integrationSecurity
Found a vulnerability? See SECURITY.md.
