Skip to main content
GET
/
org
/
get_usage
Get Organization Usage
curl --request GET \
  --url https://dev.platformbackend.unsiloed.ai/api/v1/org/get_usage \
  --header 'api-key: <api-key>'
{
  "org_id": "<string>",
  "org_name": "<string>",
  "current_usage": 123,
  "usage_limit": 123,
  "remaining_quota": 123,
  "last_billed_date": "2023-12-25"
}

​
Overview

The Get Organization Usage endpoint allows you to check your organization’s current API usage, monthly limits, and remaining quota. This endpoint uses API key authentication and automatically handles billing cycle resets when applicable.
This endpoint requires a valid API key in the request header. The usage information is specific to the organization associated with the API key.

​
Authentication

​
api-key
string
required
Your organization’s API key for authentication. Format: unsiloed_[hash]

​
Response

​
org_id
string
Unique identifier for your organization
​
org_name
string
Name of your organization
​
current_usage
number
Number of credits used in the current billing cycle
​
usage_limit
number
Total monthly usage limit (credits) for your organization
​
remaining_quota
number
Number of credits remaining in the current billing cycle. Calculated as: usage_limit - current_usage
​
last_billed_date
string
Date of the last billing cycle reset in ISO 8601 format (YYYY-MM-DD). Usage resets automatically every 30 days.

Authorizations

​
api-key
string
header
required

Response

Usage information retrieved successfully

​
org_id
string

Unique identifier for your organization

​
org_name
string

Name of your organization

​
current_usage
number

Number of credits used in the current billing cycle

​
usage_limit
number

Total usage limit (credits) for your organization

​
remaining_quota
number

Number of credits remaining in the current billing cycle

​
last_billed_date
string<date>

Date of the last billing cycle reset (YYYY-MM-DD)