Skip to content
Last updated

Retrieve comprehensive usage limits information for an organization, including organization-level limits, total API key limits, and per-API-key breakdowns.

Limit Hierarchy

The system enforces a three-tier limit hierarchy:

  1. Organization Limit - Total spending across all usage types (broadest)
  2. Total API Key Limit - Combined spending of all API keys (medium)
  3. Individual API Key Limit - Spending for a specific API key (narrowest)

When processing requests, limits are checked in this order. If any limit is exceeded, the request is rejected with a 429 error.

GEThttps://api.aitronos.com/v1/analytics/usage/limits/{org_id}

Path Parameters

org_id string required

The organization ID (format: org_<uuid>).

Query Parameters

month integer optional

Month to query (1-12). Defaults to current month.

year integer optional

Year to query. Defaults to current year.

Returns

Returns comprehensive usage limits information including organization limits, total API key limits, per-API-key breakdowns, and summary statistics.

Response Fields

organization_limits object

Organization-level spending limits and usage.

api_limits object

Total API key spending limits and aggregate usage across all API keys. Returns null if no total API key limit is configured.

api_key_limits array

Individual API key limits and usage for each key in the organization.

summary object

Summary statistics including total keys, keys with limits, and overall status.

Status Values

  • ok: Utilization < 80%
  • warning: 80% ≤ utilization < 100%
  • exceeded: Utilization ≥ 100%
  • no_limit: No limit configured
Bash
curl "https://api.aitronos.com/v1/analytics/usage/limits/org_abc123" \
  -H "X-API-Key: $FREDDY_API_KEY"

Response:

{
  "organization_limits": {
    "monthly_limit": 10000.00,
    "current_usage": 8250.50,
    "utilization_percentage": 82.51,
    "remaining_budget": 1749.50,
    "status": "warning"
  },
  "api_limits": {
    "monthly_limit": 7000.00,
    "current_usage": 6250.50,
    "utilization_percentage": 89.29,
    "remaining_budget": 749.50,
    "status": "warning"
  },
  "api_key_limits": [
    {
      "api_key_id": "apikey_abc123",
      "api_key_name": "Production Key",
      "monthly_limit": 5000.00,
      "current_usage": 4500.00,
      "utilization_percentage": 90.00,
      "status": "warning"
    },
    {
      "api_key_id": "apikey_def456",
      "api_key_name": "Development Key",
      "monthly_limit": 2000.00,
      "current_usage": 1750.50,
      "utilization_percentage": 87.53,
      "status": "warning"
    },
    {
      "api_key_id": "apikey_ghi789",
      "api_key_name": "Test Key",
      "monthly_limit": null,
      "current_usage": 0.00,
      "utilization_percentage": null,
      "status": "no_limit"
    }
  ],
  "summary": {
    "total_keys": 3,
    "keys_with_limits": 2,
    "keys_exceeded": 0,
    "overall_status": "warning"
  }
}

Response:

{
  "organization_limits": {
    "monthly_limit": 10000.00,
    "current_usage": 8250.50,
    "utilization_percentage": 82.51,
    "remaining_budget": 1749.50,
    "status": "warning"
  },
  "api_limits": {
    "monthly_limit": 7000.00,
    "current_usage": 6250.50,
    "utilization_percentage": 89.29,
    "remaining_budget": 749.50,
    "status": "warning"
  },
  "api_key_limits": [
    {
      "api_key_id": "apikey_abc123",
      "api_key_name": "Production Key",
      "monthly_limit": 5000.00,
      "current_usage": 4500.00,
      "utilization_percentage": 90.00,
      "status": "warning"
    },
    {
      "api_key_id": "apikey_def456",
      "api_key_name": "Development Key",
      "monthly_limit": 2000.00,
      "current_usage": 1750.50,
      "utilization_percentage": 87.53,
      "status": "warning"
    },
    {
      "api_key_id": "apikey_ghi789",
      "api_key_name": "Test Key",
      "monthly_limit": null,
      "current_usage": 0.00,
      "utilization_percentage": null,
      "status": "no_limit"
    }
  ],
  "summary": {
    "total_keys": 3,
    "keys_with_limits": 2,
    "keys_exceeded": 0,
    "overall_status": "warning"
  }
}