Get usage

GEThttps://api.typesearch.ai/v1/usage

Returns what the calling key has used today (since 00:00 UTC) and over the last 30 days, and its limits. It spends no tokens.

Response

object"usage"
Always usage.
keyobject
The key making the request.
Show child attributes
- idstring
  The key’s visible prefix.
- namestring
  The name given to the key.
limitsobject
The key’s limits.
Show child attributes
- tokens_per_dayinteger
  Daily model-token quota. Resets at 00:00 UTC.
  Range: -9007199254740991–9007199254740991
- requests_per_minuteinteger
  Requests allowed per minute.
  Range: -9007199254740991–9007199254740991
- requests_per_secondinteger | null
  Range: -9007199254740991–9007199254740991
todayobject
Usage since 00:00 UTC.
Show child attributes
- requestsinteger
  Requests.
  Range: -9007199254740991–9007199254740991
- tokensinteger
  Model tokens.
  Range: -9007199254740991–9007199254740991
- cost_usdnumber
  Cost in US dollars.
- remaining_tokensinteger
  Tokens left today.
  Range: -9007199254740991–9007199254740991
last_30_daysobject
Usage over the last 30 days.
Show child attributes
- requestsinteger
  Requests.
  Range: -9007199254740991–9007199254740991
- tokensinteger
  Model tokens.
  Range: -9007199254740991–9007199254740991
- cost_usdnumber
  Cost in US dollars.
creditobject | null
Show child attributes
- balance_usdnumber
- planenum<string>
  One of: payg · plan
- spent_this_month_usdnumber
- monthly_limit_usdnumber | null

const usage = await ts.usage();
console.log(usage.today.remaining_tokens);

200 OK

{
  "object": "usage",
  "key": { "id": "ts_live_Xk3P9qaB", "name": "Production" },
  "limits": { "tokens_per_day": 1000000, "requests_per_minute": 60 },
  "today": { "requests": 412, "tokens": 183920, "cost_usd": 0.41, "remaining_tokens": 816080 },
  "last_30_days": { "requests": 9120, "tokens": 4102330, "cost_usd": 9.12 }
}