Skip to main content
GET
/
api
/
v1
/
usage
Get usage
curl --request GET \
  --url https://shelfforce.ai/api/v1/usage \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "credits": {
      "remaining": 123,
      "usedThisPeriod": 123,
      "plan": 123,
      "payg": 123
    },
    "plan": {
      "tier": "<string>",
      "billingInterval": "monthly",
      "periodEnd": "2023-11-07T05:31:56Z"
    },
    "rateLimits": {
      "analyses": {
        "limit": 123,
        "remaining": 123,
        "resetAt": "2023-11-07T05:31:56Z"
      },
      "reads": {
        "limit": 123,
        "remaining": 123,
        "resetAt": "2023-11-07T05:31:56Z"
      },
      "writes": {
        "limit": 123,
        "remaining": 123,
        "resetAt": "2023-11-07T05:31:56Z"
      }
    }
  }
}

Authorizations

Authorization
string
header
required

API key with sf_live_ prefix. Pass as Authorization: Bearer sf_live_...

Response

Usage and plan details.

data
object
required