Skip to main content

Adapters

This section covers the official integration paths for using Vluna in application code and agent runtimes.

Use this section when you want:

  • the official SDKs for Python or TypeScript
  • a concrete runtime integration shape for a known framework
  • guidance on when to use SDKs, direct HTTP, or framework-specific adapters
  • guidance on where to attach authorize -> commit/cancel
  • links to the corresponding Python and TypeScript adapter source and examples

Start here​

What this section is for​

This section is about integration shape, not about billing-plan design.

These pages focus on:

  • choosing between SDK, HTTP, and runtime adapter approaches
  • selecting the right runtime boundary
  • carrying request context correctly
  • extracting actual usage
  • handling streaming, retries, and tool calls
  • deciding when to use top-level quantity_minor and when to also send meters[]

Integration paths​

  • SDK overview
    • Use this when you want the official Python or TypeScript client library.
  • LLM integration guide
    • Use this when you need to decide where usage gating should sit in an LLM or agent runtime.
  • Framework adapter pages
    • Use these when you already know the runtime you are integrating with and want a concrete reference implementation.

Artifact expectations​

The downloadable adapter artifacts are not all meant to be used the same way.

  • vluna_adapter.py / vluna_adapter.ts
    • Treat these as the primary integration templates.
    • If your runtime matches the corresponding SDK or framework, you can usually copy them into your repository, make a small number of project-specific changes, and try them directly.
  • vluna_plugin.py / vluna_plugin.ts
    • Treat these the same way when the framework exposes a plugin or callback model.
    • They are intended to be copied and adapted, not just read.
  • example.py / example.ts
    • Treat these as demos of how to call the adapter from application code.
    • They show runtime wiring and invocation shape, but they are not the primary files to paste into production as-is.
  • README.md
    • Treat these as setup notes for that framework-specific example package when present.

Downloadable artifacts​