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, its limits, the credit of its organization and the price list: pricing, in USD per 1,000 requests for each search mode, similar and live site search, and per 1,000 pages for contents. 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
  Requests allowed per second, set by the plan. null for internal keys.
  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
The credit of the organization behind this key. null for internal keys, which aren’t billed.
Show child attributes
- balance_usdnumber
  The balance available now, in US dollars.
- planenum<string>
  payg (pay as you go) or plan (a monthly credit plan).
- spent_this_month_usdnumber
  What this key has spent since the 1st of the month (UTC), in US dollars.
- monthly_limit_usdnumber | null
  The key’s monthly spending cap, in US dollars: once reached, its requests get a 402 spend_limit_reached until the next month or until you raise it. null when it has none.
pricingobject
Show child attributes
- currency"USD"
- per_1000_requestsobject
  Show child attributes
  - ultranumber
  - fastnumber
  - normalnumber
  - deepnumber
  - similarnumber
  - similar_deepnumber
  - site_searchnumber
- per_1000_pagesobject
  Show child attributes
  - contentsnumber
  - contents_with_querynumber
- per_1000_urls_per_monthobject
  Show child attributes
  - custom_indexnumber
- per_1000_chartsobject
  Show child attributes
  - query_addonnumber
  - from_datanumber

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": 50000000, "requests_per_minute": 600, "requests_per_second": 10 },
  "today": { "requests": 412, "tokens": 183920, "cost_usd": 0.41, "remaining_tokens": 816080 },
  "last_30_days": { "requests": 9120, "tokens": 4102330, "cost_usd": 9.12 },
  "credit": { "balance_usd": 42.6, "plan": "payg", "spent_this_month_usd": 9.12, "monthly_limit_usd": null },
  "pricing": {
    "currency": "USD",
    "per_1000_requests": {
      "ultra": 1, "fast": 1.4, "normal": 2.2, "deep": 5.6,
      "similar": 2.2, "similar_deep": 4.6, "site_search": 2.4
    },
    "per_1000_pages": { "contents": 0.2, "contents_with_query": 0.4 }
  }
}