Skip to main content
GET
/
usage
Get Usage
curl --request GET \
  --url https://api.shovels.ai/v2/usage \
  --header 'X-API-Key: <api-key>'
{
  "credits_used": 123,
  "credit_limit": 123,
  "is_over_limit": true,
  "available_at": "2023-12-25",
  "daily_usage": [
    {
      "date": "2023-12-25",
      "credits": 123,
      "expires": "2023-12-25"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.shovels.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Response

200 - application/json

Current credit usage and limit

Response model for credit usage endpoint.

​
credits_used
integer
required

Total credits used in the last 30 days.

​
credit_limit
integer | null
required

Monthly credit limit. NULL means unlimited.

​
is_over_limit
boolean
required

Whether the user has reached or exceeded their limit.

​
available_at
string<date> | null
required

Earliest date when expiring credits bring usage below limit. NULL if under limit or unlimited.

​
daily_usage
DailyUsage · object[]
required

Daily credit consumption with expiry dates for the rolling 30-day window.