Read a virtual key's spend

Aggregate spend and request count for one key over a window given in epoch milliseconds (default: current UTC calendar month). Returns 412 spend_source_unavailable on deploys without a ClickHouse spend source.

GET /api/gateway/v1/virtual-keys/{id}/spend

Read a virtual key's spend

Python

import requests

url = "https://app.langwatch.ai/api/gateway/v1/virtual-keys/{id}/spend"

headers = {"X-Auth-Token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

200

{
  "virtual_key_id": "<string>",
  "spent_usd": "<string>",
  "requests": 0,
  "window": {
    "from": 0,
    "to": 0
  }
}

Authorizations

X-Auth-Token · string · header · required

Project API key for sending traces and accessing project-scoped resources. Format: sk-lw-... (no underscore). Obtain one by creating a project via the Admin API or the LangWatch UI.

Path Parameters

id · string · required

Minimum string length: 1

Query Parameters

from · integer

Required range: x <= 8640000000000000

to · integer

Required range: x <= 8640000000000000

Response

200

application/json

Success

virtual_key_id · string · required

spent_usd · string · required

requests · integer · required

Required range: -9007199254740991 <= x <= 9007199254740991

window · object · required

Show child attributes