Paxa Labs
Sign in

Get key, balance, and plan

GEThttps://api.paxalabs.com/v1/me

GET /v1/me reports the presented key, the live credit balance in both buckets, and the effective plan with its rate limit and concurrency.

View as Markdown
curl https://api.paxalabs.com/v1/me \
  -H "Authorization: Bearer $PAXA_API_KEY"
{
  "key": {
    "id": "6b9f1a52-1b6e-4c9d-9f34-58a4c2f9d3aa",
    "name": "production",
    "key_start": "pxa_a3f2k9",
    "credit_limit": null,
    "credits_spent": 1240.39,
    "created_at": "2026-07-02T09:14:07.412Z",
    "last_used_at": "2026-08-03T05:41:52.108Z"
  },
  "balance": {
    "wallet": 8200,
    "plan": 14759.61,
    "total": 22959.61
  },
  "plan": {
    "key": "standard",
    "rpm": 200,
    "concurrency": 15,
    "monthly_credits": 25200
  }
}

Poll this endpoint when reconciling usage. credits_spent can lag live spend by up to 5 minutes.

Headers#

authorizationBearer pxa_...Required

Authorization: Bearer pxa_... (recommended).

x-api-keypxa_...

Alternative to the Authorization header. Ignored when Authorization is present.

Authentication

Response#

Key, balance, and plan for the authenticated account.

keyobjectRequired

The API key that authenticated this request.

Show properties
key.idstringRequired

Key id.

key.namestringRequired

The label given to the key at creation.

key.key_startstringRequired

First characters of the key, for display.

key.credit_limitnumber or nullRequired

Spending cap for this key in credits; null means uncapped.

key.credits_spentnumberRequired

Credits this key has spent, exact to a hundredth (may lag live spend by up to 5 minutes).

key.created_atstringRequired

Creation time, ISO 8601.

key.last_used_atstring or nullRequired

Last verified use, ISO 8601; null when never used.

balanceobjectRequired

Live credit balance of the account, exact to a hundredth of a credit.

Show properties
balance.walletnumberRequired

Purchased and granted credits; never expire.

balance.plannumberRequired

Monthly plan credits; reset each billing period and spend first.

balance.totalnumberRequired

wallet plus plan.

planobjectRequired

The effective plan.

Show properties
plan.keystringRequired

Plan key: "free", "starter", "standard", or "pro".

plan.rpminteger or nullRequired

Requests per minute the plan allows; null means no limit. One window covers the whole account, across every product.

plan.concurrencyintegerRequired

Concurrent requests the plan allows, counted per product. An open live connection holds one slot of its product.

plan.monthly_creditsintegerRequired

Credits granted each billing period; 0 on the free plan.

Errors#

401unauthorizedThe request carried no API key, or the key is invalid or disabled.
PreviousList speech models (OpenAI-compatible)NextSend feedback