DocsUsage Summary
Billing

GET /v1/usage/summary

Fetch aggregated usage totals for summary cards and dashboard views.

GET /v1/usage/summaryScope: api.read

Best for

Teams building billing dashboards and high-level account summaries.

Summary cards
Total spend
Top models

How to call it

json

{
  "model": "hailuo-2.3-pro",
  "prompt": "讓商品照慢慢旋轉,背景保持乾淨",
  "images": [
    "https://example.com/product.png"
  ],
  "duration": 6,
  "resolution": "1080P"
}

What this API is for

Use this endpoint for overview cards.

It complements usage logs by giving totals instead of per-request rows.

Parameters

date range

Optional date window for summary aggregation if supported.

groupBy

Optional grouping such as by model when supported.

Response fields

totalPointsCharged

Total charged points for the selected period.

totalRequests

Total requests in the selected period.

totalInputTokens / totalOutputTokens

Aggregated token totals when relevant.

byModel

Per-model summary breakdown.

Frontend notes

  • Use this endpoint for dashboard cards.
  • Show total points, total requests, and top models first.
  • Pair it with usage logs for detailed drill-down.

Ready to test with your own key?

Create a general API key in Settings, then come back here to copy a request example.

Open API Keys