Skip to content
renderkit
API referenceAccount & usage

Account & usage

These endpoints back the dashboard and are authenticated with a session JWT (Authorization: Bearer …), not an API key. Use them to read your balance, chart usage, and rotate keys programmatically.

Get current account

GEThttps://api.renderkit.tech/v1/me
200 · application/json
{
  "success": true,
  "data": {
    "id": "usr_4f1a…",
    "email": "[email protected]",
    "name": "Ada Lovelace",
    "role": "user",
    "plan": "growth",
    "status": "active",
    "credits": { "total": 25000, "used": 3120, "remaining": 21880 },
    "api_keys": [ { "_id": "key_91…", "name": "production", "key_prefix": "rk_live_a1b2", "tier": "growth", "is_active": true } ],
    "created_at": "2026-01-04T09:00:00.000Z"
  },
  "message": "Success"
}

Usage analytics

Pre-aggregated daily usage buckets — cheap to query over any range.

GEThttps://api.renderkit.tech/v1/usage

Query parameters

ParameterDescription
fromstringStart date, YYYY-MM-DD (inclusive).
tostringEnd date, YYYY-MM-DD (inclusive).
endpointstringFilter to one primitive. Options: screenshot, pdf, extract.
200 · application/json
{
  "success": true,
  "data": {
    "totals": { "renders": 3120, "credits": 4010, "cache_hits": 412, "errors": 7 },
    "daily": [
      { "date": "2026-06-13", "endpoint": "screenshot", "renders_count": 220, "credits_used": 220, "cache_hits": 30, "errors_count": 0 }
    ]
  },
  "message": "Success"
}

API keys

List, create, and revoke keys. New keys inherit your current plan as their tier; the plaintext value is returned once on creation.

MethodPathPurpose
GET/v1/keysList your keys (prefixes only).
POST/v1/keysCreate a key. Body: { name }. Returns the plaintext once.
DELETE/v1/keys/:idRevoke a key immediately (cache flush within 60s).
201 · POST /v1/keys
{
  "success": true,
  "data": {
    "id": "key_91…",
    "name": "production",
    "prefix": "rk_live_a1b2",
    "tier": "growth",
    "plain": "rk_live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6"
  },
  "message": "Store this key now — it is shown once."
}

The plaintext key appears once

data.plain is only ever returned by this create call (and the one-time claim after signup). Store it in a secret manager immediately — RenderKit keeps only its hash.

Documentation