SkimmerDB Docs
API reference

Usage

What you used and what it costs.

Kept in this tab only and sent only to api.skimmerdb.com. Requests run against your account and count as usage. Make a key.

Usage and bill this period

GET /v1/usage

This billing period so far and what it costs. Metered per tenant per UTC day: storage (GB-months), documents and bytes written, queries and the object-storage reads they made, the MCP part of queries and writes.

Parameters

daysboolean · queryAdd the period day by day (days).

Answer

daysUsageDay[]
days[].daystring
days[].queriesinteger
days[].writesinteger
days[].write_bytesinteger
days[].docs_writteninteger
days[].store_getsinteger
days[].store_bytesinteger
days[].mcp_queriesinteger
days[].mcp_writesinteger
days[].embed_tokensinteger
days[].cpu_msnumber
days[].out_bytesinteger
days[].gb_monthsnumber
period_startstringThis billing period's first day (UTC).
monthstring
queriesintegerSearches, counts, reads, warms and SQL queries (metered).
writesintegerDocuments written or deleted.
write_bytesinteger
docs_writteninteger
store_getsintegerObject-storage reads made by queries (cold queries cost more).
store_bytesinteger
mcp_queriesinteger
mcp_writesinteger
embed_tokensinteger
cpu_msnumberCPU queries used (metered; the free plan includes plan.included_cpu_seconds).
out_bytesintegerBytes of answers sent back (metered; the free plan includes plan.included_out_gb).
stored_bytesinteger
gb_monthsnumberStorage so far this period.
planPlan
plan.namestring
plan.price_monthnumber
plan.included_gb_monthsnumber
plan.included_write_gbnumber
plan.included_queriesinteger
plan.included_writesinteger
plan.included_embed_tokensinteger
plan.per_gb_monthnumber
plan.per_gb_writtennumber
plan.per_million_queriesnumber
plan.per_million_embed_tokensnumber
plan.per_million_store_getsnumber
plan.hard_limitboolean
plan.qpsinteger
plan.concurrencyinteger
plan.storage_quota_gbnumber
plan.read_inflight_mbinteger
plan.sql_secondsinteger
plan.sql_concurrencyinteger
plan.query_secondsinteger
plan.max_namespacesinteger
plan.included_cpu_secondsnumber
plan.included_store_getsinteger
plan.included_out_gbnumber
plan.max_creates_dayinteger
plan.unverified_sharenumber
billBillWhat this period costs so far, in dollars.
bill.basenumber
bill.storagenumber
bill.writesnumber
bill.queriesnumber
bill.embeddingnumber
bill.readsnumber
bill.usagenumber
bill.totalnumber

Status codes

200OK
401No key, or an unknown or revoked one.
curl -s https://api.skimmerdb.com/v1/usage \
  -H "Authorization: Bearer $KEY"
from skimmerdb import SkimmerDB
from skimmerdb._api.api.usage import get_usage

db = SkimmerDB()  # SKIMMERDB_KEY
answer = get_usage.sync(client=db.api)
import { SkimmerDB } from "skimmerdb";
import { getUsage } from "skimmerdb/api";

const db = new SkimmerDB(); // SKIMMERDB_KEY
const { data } = await getUsage({ client: db.client });
200 answer
{
  "period_start": "2026-10-01",
  "month": "2026-10",
  "queries": 1830,
  "writes": 52040,
  "write_bytes": 54100231,
  "docs_written": 52000,
  "store_gets": 412,
  "store_bytes": 3100220,
  "cpu_ms": 912.5,
  "out_bytes": 8120544,
  "mcp_queries": 640,
  "mcp_writes": 12,
  "embed_tokens": 0,
  "stored_bytes": 29411022,
  "gb_months": 0.0021,
  "plan": {
    "name": "free",
    "price_month": 0,
    "included_gb_months": 1,
    "included_write_gb": 1,
    "included_queries": 100000,
    "included_writes": 100000,
    "included_embed_tokens": 0,
    "per_gb_month": 0,
    "per_gb_written": 0,
    "per_million_queries": 0,
    "per_million_embed_tokens": 0,
    "per_million_store_gets": 0,
    "hard_limit": true,
    "qps": 100,
    "concurrency": 16,
    "storage_quota_gb": 1,
    "read_inflight_mb": 64,
    "sql_seconds": 10,
    "sql_concurrency": 2,
    "query_seconds": 10,
    "max_namespaces": 1000,
    "included_cpu_seconds": 3600,
    "included_store_gets": 1000000,
    "included_out_gb": 10,
    "max_creates_day": 1000,
    "unverified_share": 0.01
  },
  "bill": {
    "base": 0,
    "storage": 0,
    "writes": 0,
    "queries": 0,
    "embedding": 0,
    "reads": 0,
    "usage": 0,
    "total": 0
  }
}