BeefAPIEndpoints
Read key usage
Read this API key’s USD spending and settlement totals.
GET
/v1/usageSend your API key in the Authorization: Bearer YOUR_BEEFAPI_KEY header. Get an API key →
Request example
Use your key. Replace sample task IDs and image URLs.
curl -X GET "https://global.beefapi.com/v1/usage" \ -H "Authorization: Bearer YOUR_BEEFAPI_KEY"Response examples
Illustrative values. Select a status code.
Recorded usage totals, by model and UTC day.
{ "settled_amount": "string", "pending_amount": "string", "refunded_amount": "string", "records": 0, "unknown_records": 0, "currency": "USD", "start_time": 0, "end_time": 0, "by_model": [ { "settled_amount": "string", "pending_amount": "string", "refunded_amount": "string", "records": 0, "unknown_records": 0, "model": "string" } ], "daily": [ { "settled_amount": "string", "pending_amount": "string", "refunded_amount": "string", "records": 0, "unknown_records": 0, "date": "2019-08-24" } ]}Query Parameters
| Parameter | Description |
|---|---|
start_time | Inclusive Unix timestamp. Defaults to 30 days before end_time. Minimum: Format: |
| Parameter | Description |
|---|---|
end_time | Exclusive Unix timestamp. Defaults to now. Maximum window: 31 days. Minimum: Format: |
| Parameter | Description |
|---|---|
model | Exact model ID. Max. characters: |
| Parameter | Description |
|---|---|
request_id | Match a recorded request or its linked funding receipt. Max. characters: |
Response fields & status codes
Response fields
application/json
application/json
application/json
application/json
application/json