Armox
    Armox Academy 📚
    Academy.apiReferenceAcademy.apiGettingStartedAcademy.apiAccount
    Copy to LLM

    Account Endpoint

    Use this endpoint to inspect your API account state and usage summary.

    Base path:

    • GET /api/v1/account

    GET /api/v1/account

    Returns:

    • remaining credits
    • subscription metadata
    • usage summary (last 30 days)
    • active API key count

    Request

    curl -X GET "https://armox.ai/api/v1/account" \
  -H "Authorization: Bearer sk_live_your_key_here"

    Response

    {
  "object": "account",
  "user_id": "user_123",
  "credits": 8420,
  "subscription": "agency",
  "usage": {
    "credits_used_last_30d": 12480,
    "total_requests_last_30d": 931,
    "total_jobs": 415
  },
  "api_keys": {
    "active": 3
  }
}

    Typical Uses

    • show credits in your internal admin panel
    • monitor 30-day usage trends
    • check active key count for security audits
    • trigger alerts when credits are low

    JavaScript Example

    const response = await fetch("https://armox.ai/api/v1/account", {
  headers: {
    Authorization: "Bearer sk_live_your_key_here",
  },
});

const account = await response.json();
console.log(account.credits, account.usage);

    Python Example

    Prompt Template
    import requests

response = requests.get(
    "https://armox.ai/api/v1/account",
    headers={"Authorization": "Bearer sk_live_your_key_here"},
)

account = response.json()
print(account["credits"])
print(account["usage"])

    Related Pages