Get account usage and concurrency

GET

https://api.beatapi.io/v1/usage

GET

/v1/usage

curl https://api.beatapi.io/v1/usage \
     -H "Authorization: Bearer <token>"

{
  "data": {
    "object": "usage",
    "period": "all",
    "credit_balance": 21.6,
    "total_tasks": 12,
    "credits_settled": 14.4,
    "credits_refunded": 9,
    "concurrency": {
      "limit": 2,
      "active": 1
    },
    "by_workflow": [
      {
        "workflow": "music-video",
        "tasks": 8,
        "credits_settled": 9.6
      },
      {
        "workflow": "ecommerce-video",
        "tasks": 4,
        "credits_settled": 4.8
      }
    ],
    "by_capability": [
      {
        "task_kind": "image",
        "capability_id": "seedream-5-pro",
        "tasks": 3,
        "credits_settled": 0.42
      },
      {
        "task_kind": "video",
        "capability_id": "veo-3.1",
        "tasks": 2,
        "credits_settled": 14
      }
    ],
    "by_model": [
      {
        "media_type": "image",
        "model": "seedream-5-pro",
        "tasks": 3,
        "credits_settled": 0.42
      }
    ],
    "by_api_key": [
      {
        "api_key_id": "key_abc123",
        "title": "Production",
        "key_prefix": "sk_live_abcd",
        "tasks": 12,
        "credits_settled": 14.4
      }
    ],
    "realtime": {
      "sessions": 3,
      "credits": 1.8,
      "active": 1
    }
  }
}

The account’s balance, spend and breakdowns. Without period the counts cover the whole account history; with period they cover the window ending now, and the reply repeats period, since and until so a caller can tell which figure it got. credit_balance and concurrency are always current. A query parameter other than period, or a period outside the set, is refused with 400 rather than ignored.

認証

AuthorizationBearer

Send your API key as Authorization: Bearer <BEATAPI_API_KEY>.

クエリパラメータ

periodenumオプションデフォルト値 all

The window the counts and breakdowns cover, ending now. all (the default) is the whole account history.

許可された値:

レスポンス

Usage summary

dataobject

エラー

400

Bad Request Error

401

Unauthorized Error