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>"

1 {
2   "data": {
3     "object": "usage",
4     "credit_balance": 21.6,
5     "total_tasks": 12,
6     "credits_settled": 14.4,
7     "credits_refunded": 9,
8     "concurrency": {
9       "limit": 2,
10       "active": 1
11     },
12     "by_workflow": [
13       {
14         "workflow": "music-video",
15         "tasks": 8,
16         "credits_settled": 9.6
17       },
18       {
19         "workflow": "ecommerce-video",
20         "tasks": 4,
21         "credits_settled": 4.8
22       }
23     ],
24     "by_capability": [
25       {
26         "task_kind": "image",
27         "capability_id": "seedream-5-pro",
28         "tasks": 3,
29         "credits_settled": 0.42
30       },
31       {
32         "task_kind": "video",
33         "capability_id": "veo-3.1",
34         "tasks": 2,
35         "credits_settled": 14
36       }
37     ],
38     "by_model": [
39       {
40         "media_type": "image",
41         "model": "seedream-5-pro",
42         "tasks": 3,
43         "credits_settled": 0.42
44       }
45     ],
46     "by_api_key": [
47       {
48         "api_key_id": "key_abc123",
49         "title": "Production",
50         "key_prefix": "sk_live_abcd",
51         "tasks": 12,
52         "credits_settled": 14.4
53       }
54     ],
55     "realtime": {
56       "sessions": 3,
57       "credits": 1.8,
58       "active": 1
59     }
60   }
61 }

Authentication

AuthorizationBearer

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

Response

Usage summary

dataobject

Errors

401

Unauthorized Error