Account & usage

Inspect your balance and usage, and configure where results are stored.

Balance

{ "status": "success", "balance": 100, "plan": "FREE" }

A key with assigned credits

An organization can set credits aside for one API key — an agency gives each of its clients a key with its own budget. Only that key can spend them. Such a key reads only itself: balance is what it can spend, keyCredits is its budget, and the usage endpoints below return its own calls only.

{
  "status": "success",
  "scope": "key",
  "balance": 820,
  "keyCredits": { "balance": 820, "assignedTotal": 1000, "spentTotal": 180, "onEmpty": "stop" }
}

When the assigned credits run out, calls fail with 402 KEY_CREDITS_EXHAUSTED — unless the owner set the key to continue on the organization’s shared credits. Credits are assigned in the dashboard, under API keys → Credits.

Usage history

{
  "status": "success",
  "recent": [
    { "id": "...", "service": "ocr", "credits": 1, "latencyMs": 842, "status": "success", "createdAt": "..." }
  ],
  "summary": [ { "service": "ocr", "calls": 42, "credits": 42 } ]
}

Aggregate stats

Returns aggregates by service, by key, by status, and a time series — handy for building a usage dashboard.

Overview

Everything the dashboard’s Reports page shows, in one call: totals for the period and for the equal period before it, a daily series, and the top services, keys, projects and members. Takes from, to (days, default this month so far), tz (default Asia/Vientiane), and the filters service, apiKeyId (or none for the web app), projectId and userId. Each top list ignores only its own filter, so a filtered row stays visible beside its peers. Postpaid organizations also get amounts in kip at their contract rate. A key with assigned credits sees only itself.

Bring-your-own storage

Configure an S3‑compatible bucket to hold stored results.