Skip to main content
GET
/
billing
/
usage
cURL
curl --request GET \
  --url https://api.useanima.sh/v1/billing/usage \
  --header 'Authorization: Bearer <token>'
{
  "period": "<string>",
  "usage": {
    "message_sent": 1,
    "message_received": 1,
    "sms_sent": 1,
    "sms_received": 1,
    "call_minute": 1,
    "embedding_generated": 1
  }
}

Authorizations

Authorization
string
header
required

JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer

Response

200 - application/json

OK

Usage metrics for a specific billing period

period
string
required

Billing period in YYYY-MM format

Pattern: ^\d{4}-\d{2}$
usage
object
required

Breakdown of resource usage by category