Skip to main content

llm-router-ledger

Route LLM calls through one send_message() for text and one create_embeddings() for vectors, and keep a JSONL ledger of every request and response for offline cost reconciliation.

Provider support

Status Adapter Providers
Supported direct Anthropic
Supported OpenAI-compat Azure OpenAI, DeepSeek, Local LM Studio, Local Ollama, MiniMax, OpenAI, OpenRouter, Qwen, Zhipu / GLM
Supported via OpenRouter ByteDance Seed, InclusionAI Ling, Nvidia Nemotron, Xiaomi MiMo
Planned direct Gemini
  • Every "Supported" row is live-smoke-verified end-to-end.
  • Anthropic requires the optional [anthropic] extra: uv pip install llm-router-ledger[anthropic].
  • For the "via OpenRouter" families, use provider: openrouter with the appropriate model id.
  • The table above is about text. Embeddings are gated separately and verified on OpenRouter, Ollama and LM Studio only; see Embeddings.

Free chat models

Verified end-to-end via OpenRouter and configured in examples/llm_endpoints.example.yaml. Rates are USD per 1M tokens. Both endpoints declare an explicit 0.00 rather than omitting cost, so the ledger records their tokens the same way it does a paid endpoint.

Model In Out Context
nvidia/nemotron-3.5-content-safety:free 0.00 0.00 128000
nvidia/nemotron-3.5-lightning:free 0.00 0.00 1000000

Free models share their capacity with everyone else using them, so a call fails with HTTP 429 when they are busy. One of the two above failed nine times in a row during verification.

nvidia/nemotron-3.5-content-safety:free is a safety classifier, not a general chat model. It answers every prompt with a verdict, so What is 17 * 23? returns User Safety: safe.

Install

uv pip install llm-router-ledger

Quickstart

Set OPENROUTER_API_KEY in .env and create llm_endpoints.yaml in the working directory. The fastest path is to copy examples/llm_endpoints.example.yaml to llm_endpoints.yaml in your working directory and edit it.

from llm_router_ledger import UsageTracker, send_message

tracker = UsageTracker(
    log_path="logs/usage.jsonl",
    project_id="my-blog",
)
result = send_message(
    endpoint_name="openrouter-mimo-v2.5",
    system="You are concise.",
    user="Explain prompt caching in two sentences.",
    tracker=tracker,
)

Or against a local Ollama server, with no API costs:

result = send_message(
    endpoint_name="local-llama",
    system="You are concise.",
    user="Explain prompt caching in two sentences.",
    tracker=tracker,
)
  • send_message() returns a ChatResult with .text, .usage, and .generation_id.
  • .usage adds cost, is_byok, and upstream_provider to the token keys when the provider reports them, plus flattened reasoning / cache detail keys (e.g. completion_reasoning_tokens, prompt_cached_tokens); see JSONL ledger schema.
  • UsageTracker appends paired llm_request / llm_response events to the JSONL log, stamped with project_id, run_tag, run_label, and purpose for later grouping.
  • Prompt and response previews are redacted by default; pass preview_length to opt in to storing truncated text, see JSONL ledger schema.
  • For multi-turn conversations, tool loops, or anything system + user can't express, pass messages instead; it replaces system and user outright rather than merging with them:
result = send_message(
    endpoint_name="openrouter-mimo-v2.5",
    messages=[
        {"role": "system", "content": [{"type": "text", "text": "You are concise."}]},
        {"role": "user", "content": [{"type": "text", "text": "Explain prompt caching."}]},
        {"role": "assistant", "content": [{"type": "text", "text": "..."}]},
        {"role": "user", "content": [{"type": "text", "text": "Now in one sentence."}]},
    ],
    tracker=tracker,
)

Each entry is {"role": ..., "content": [{"type": "text", "text": ...}]}, the OpenAI content-parts shape. It's kept even though only "text" parts are supported today, so adding image input later is additive rather than another break.

Embeddings

create_embeddings() embeds a list of texts and writes the same paired ledger events as send_message().

from llm_router_ledger import UsageTracker, create_embeddings

tracker = UsageTracker(
    log_path="logs/usage.jsonl",
    project_id="my-blog",
)
result = create_embeddings(
    endpoint_name="openrouter-embed-bge-m3",
    texts=["first passage", "second passage"],
    tracker=tracker,
)
  • create_embeddings() returns an EmbeddingResult with .vectors (one per input, in input order), .usage, and .generation_id.
  • .usage adds dimensions and embedding_count to the token keys, plus cost, is_byok, and upstream_provider when the provider reports them.
  • completion_tokens is always 0. Embeddings bill input only.

Verified models

Via OpenRouter:

Model Dims Context
baai/bge-base-en-v1.5 768 512
baai/bge-m3 1024 8194
mistralai/mistral-embed-2312 1024 8192
nvidia/nemotron-3-embed-1b:free 2048 32768
openai/text-embedding-3-large 3072 8192
openai/text-embedding-3-small 1536 8192
perplexity/pplx-embed-v1-0.6b 1024 32000
qwen/qwen3-embedding-4b 2560 32768
qwen/qwen3-embedding-8b 4096 32768

Locally via Ollama: qwen3-embedding:0.6b, 1024 dims, 32768 context (ollama pull qwen3-embedding:0.6b). The same model at Q8_0 runs under LM Studio as text-embedding-qwen3-embedding-0.6b, downloaded from the Discover tab, so local runs on either server are directly comparable.

baai/bge-base-en-v1.5 is English only. Non-English input still returns vectors, with no error.

Prices are per endpoint in llm_endpoints.yaml, each with a pricing_url and pricing_checked date. See examples/llm_endpoints.example.yaml for the verified values, and llm-router-ledger stale for ones that need rechecking.

embedding_dimensions

An optional endpoint field declaring the vector width.

  • Never sent on the wire, so a vector column or collection can be sized without first making a call. It is not OpenAI's dimensions request parameter and truncates nothing.
  • Enforced on the response: a different width raises ProviderError instead of returning vectors that would corrupt a fixed-width index.
  • OpenRouter re-routes between calls. baai/bge-m3 has been served by DeepInfra on one call and Parasail on the next.
  • Leave it unset to accept any width.

Provider gate

Embeddings are refused for providers not verified end-to-end, even where the chat adapter works: provider: openai raises NotImplementedError.

ollama and lmstudio are verified for embeddings. Other local servers are not, so they are refused despite serving the same OpenAI-compatible API.

Neither local server returns a response id, leaving provider_response_id empty. LM Studio additionally reports prompt_tokens and total_tokens as zero for embeddings, at any input size, so its rows record the vectors and their width but a token count of 0 rather than the true figure. Ollama reports real counts. Nothing is billed on either, so there is no invoice to reconcile against.

Smoke tests

python examples/smoke_test_openrouter_embeddings.py                                       # free endpoint
python examples/smoke_test_openrouter_embeddings.py --endpoint openrouter-embed-qwen3-8b
python examples/smoke_test_ollama_embeddings.py                                           # local, no cost
python examples/smoke_test_lmstudio_embeddings.py                                         # local, no cost

Each takes --input-file, one text to embed per line, in place of the sample corpus.

Per-endpoint request params

Model-specific knobs belong in config, not in every caller. Give an endpoint an extra_body and it is sent on every call to that endpoint:

endpoints:
  openrouter-deepseek:
    provider: openrouter
    model: deepseek/deepseek-chat
    api_key_env: OPENROUTER_API_KEY
    base_url: https://openrouter.ai/api/v1
    extra_body:
      reasoning:
        enabled: false
  • An extra_body passed to send_message() replaces the endpoint's value outright. The two layers are not merged, so a caller that wants both must combine them itself. An opaque vendor passthrough carries no merge rules to memorise as a result.
  • Known limitation: provider: anthropic ignores extra_body, so the field has no effect there. provider: openrouter reaches Claude with extra_body intact.

Mirroring usage elsewhere

UsageTracker.subscribe() registers a callback that receives every ledger entry, so usage can be mirrored to another store without this library depending on it:

tracker.subscribe(lambda entry: my_container.upsert_item(entry))
  • Each entry is written to the JSONL ledger before any subscriber runs.
  • A callback that raises is logged and skipped. The entry is already in the ledger, the call that produced it is unaffected, and the remaining subscribers still run.
  • Each subscriber receives its own copy of the entry.
  • Callbacks are synchronous and run on the calling thread, so a slow one delays every call. Queue the work inside the callback if the destination is remote.

JSONL ledger schema

  • UsageTracker writes two events per send_message() or create_embeddings() call: an llm_request before the call, and an llm_response after.
  • Both share a request_id so they can be paired. Top-level fields on each event include project_id, provider, model, purpose, run_tag, run_label, and timestamp.
  • The llm_response event additionally carries usage (with prompt_tokens, completion_tokens, total_tokens) and a response preview.
  • Previews are redacted by default: system_prompt_preview, user_prompt_preview, and response_preview are written as "[REDACTED]" when the underlying text is non-empty, "" when it genuinely is empty. Pass preview_length (a positive character count) to UsageTracker() to opt in to storing a truncated preview instead; the length and token counts are always recorded either way.
  • A failed call writes an llm_error event sharing the request_id of its llm_request, carrying error_type (the original SDK exception's class name), error_message, and status_code where the provider returned one. A third event type rather than an llm_response with an error field, because a failed call has no tokens and writing zeroes would corrupt anyone summing them. The SDK retries internally before raising, so one llm_error stands for however many attempts it made.
  • usage_details on the response holds everything the provider reported beyond the three token keys, written only when non-empty. usage keeps the same fixed three-key shape regardless of what lands in usage_details, across both modalities.
    • Embedding calls: dimensions and embedding_count always, plus cost, is_byok and upstream_provider where available.

Chat calls map provider fields onto ledger keys as follows. A key is written only when the provider reports a non-zero value for it.

Provider reports Ledger key Observed on
usage.prompt_tokens / completion_tokens / total_tokens usage.*, unchanged all
Anthropic usage.input_tokens / output_tokens usage.prompt_tokens / completion_tokens Anthropic
usage.cost, usage.is_byok usage_details.cost, .is_byok OpenRouter
response provider usage_details.upstream_provider OpenRouter
completion_tokens_details.reasoning_tokens usage_details.completion_reasoning_tokens OpenRouter, Qwen, Zhipu
prompt_tokens_details.cached_tokens usage_details.prompt_cached_tokens OpenRouter, DeepSeek, Zhipu
other keys in either *_tokens_details block same name, completion_ / prompt_ prefixed varies
anything else the provider reports usage_details.unmapped.<key> see below

Two keys are derived rather than reported: completion_tool_call_count, the number of tool calls on a turn that made any, and finish_reason, written only when the turn ended abnormally (e.g. length, truncated at max_tokens) in the provider's own vocabulary. A tool-call turn has no text, so it records response_length 0; the count is what distinguishes it from a model that answered with nothing.

usage_details.unmapped holds provider fields the library has no mapping for, so nothing a provider reports is silently discarded. Observed examples: DeepSeek's prompt_cache_hit_tokens and prompt_cache_miss_tokens, which duplicate prompt_cached_tokens; Qwen's completion_text_tokens and prompt_text_tokens; Azure's latency_checkpoint timing block; Anthropic's cache_read_input_tokens, cache_creation_input_tokens, cache_creation, service_tier and inference_geo. OpenAI reports nothing unmapped.

Treat unmapped as unstable. A key that later gains an explicit mapping moves out of unmapped and up a level, so read from it defensively.

Embedding calls additionally set modality: "embedding" on both events. The key is omitted entirely on text calls, so existing rows are unchanged and an absent modality means text. The response preview is empty and response_length is 0 for embeddings, since an embedding response carries no text. Neither the input text in full nor the vectors are ever written to the ledger.

Identifying a response for billing reconciliation: the response id is routed to one of two fields based on prefix:

  • generation_id: set when the id starts with "gen-" (OpenRouter convention). Use this when joining against OpenRouter's CSV export, which calls the column generation_id.
  • provider_response_id: set for everything else. OpenAI, Azure OpenAI, Ollama, and most direct-provider endpoints return ids like "chatcmpl-..." that land here. Use this when joining against OpenAI-family billing exports or any provider-native log that exposes a chat completion id.

OpenRouter embedding ids are prefixed gen-emb-, so they route to generation_id and reconcile like any other OpenRouter call. Ollama returns no id at all, leaving provider_response_id empty; nothing is billed there, so there is nothing to reconcile against.

Exactly one of the two fields is populated per llm_response event; queries that join the ledger to billing data should COALESCE over both or branch on provider.

CLI

llm-router-ledger list                          # show configured endpoints
llm-router-ledger validate llm_endpoints.yaml   # validate the YAML
llm-router-ledger stale --days 30               # endpoints with stale pricing
llm-router-ledger chat --endpoint openrouter-mimo-v2.5 --system "You are concise." --user "Hello." --log-path logs/usage.jsonl --project-id my-project

Env vars

Variable Purpose
LRL_RUN_TAG Stamped on every JSONL event.
LRL_RUN_LABEL Stamped on every JSONL event.
LRL_CONFIG_PATH Default YAML path when load_config() is called with no argument.

Development

git clone https://github.com/nirmalyaghosh/llm-router-ledger
cd llm-router-ledger
uv sync --extra dev
pytest tests/unit

Verify a local Ollama setup end-to-end with python examples/smoke_test_ollama.py (see prerequisites at the top of the script).

License

MIT. See LICENSE.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

llm_router_ledger-0.2.0.tar.gz (71.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

llm_router_ledger-0.2.0-py3-none-any.whl (41.9 kB view details)

Uploaded Python 3

File details

Details for the file llm_router_ledger-0.2.0.tar.gz.

File metadata

  • Download URL: llm_router_ledger-0.2.0.tar.gz
  • Upload date:
  • Size: 71.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for llm_router_ledger-0.2.0.tar.gz
Algorithm Hash digest
SHA256 d5f96b3892dd2f9804c221372fac84546a9fcf7aecaed249ef8146776c4292ac
MD5 040862c77ca5940abfe889e778596a05
BLAKE2b-256 51cde277c1fd7b7f6dc559ed14c972c57911e26d4f38e578a6ba7105094c71b0

See more details on using hashes here.

File details

Details for the file llm_router_ledger-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for llm_router_ledger-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f900275b95927b3bcc692ab343513431c91789140ecab5286f46ea9c68359b7e
MD5 ec114c09e9307d9a005e19d70f515147
BLAKE2b-256 1ac45e1db4140475aaec5f0e372aa18caaad30b6e9914de1055aa8a103e54f33

See more details on using hashes here.

Release history Release notifications | RSS feed

0.2.2

2 files

0.2.1

2 files

This release

0.2.0 This release

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page