Python SDK

pip install orvlin

import os
from orvlin import Orvlin

orvlin = Orvlin(
    api_key=os.environ["ORVLIN_API_KEY"],
    base_url="https://api.orvlin.com",
)

check = orvlin.check("cust_acme", "api_calls", amount=1)

if not check.has_access:
    raise PermissionError("Upgrade your plan to continue.")

orvlin.prefetch(["cust_acme", "cust_globex"])
orvlin.invalidate("cust_acme")   # or orvlin.invalidate() for everyone
state = orvlin.snapshot()        # save the cache
orvlin.restore(state)            # load it into a new process

orvlin.track({
    "customer_id": "cust_acme",
    "event_name": "api_call",
    "idempotency_key": request_id,
    "properties": {"endpoint": "/v1/search", "status_code": 200, "latency_ms": 142},
})

check = orvlin.check_credits("cust_acme", credit_type="ai_images", quantity=1)

orvlin.grant_credits("cust_acme", "ai_images", 500, source="promotional",
                     idempotency_key="promo_launch_acme")

orvlin.purchase_credits("cust_acme", "ai_images", 1000, collection="charge",
                        idempotency_key="order_20261012_001")

orvlin.set_auto_top_up("cust_acme", "ai_images", threshold=100, credits=1000,
                       max_per_month=5, enabled=True)

from orvlin import AsyncOrvlin

orvlin = AsyncOrvlin(api_key=KEY, base_url="https://api.orvlin.com")

async def handle(request):
    check = await orvlin.check("cust_acme", "api_calls", amount=1)
    ...

from orvlin import OrvlinError

try:
    orvlin.track(event)
except OrvlinError as err:
    if err.status == 401:
        ...  # the API key is missing, revoked, or has the wrong role