Skip to main content
GET
Get Organization Usage

Overview

The Get Organization Usage endpoint reports your organization’s current API usage, usage allowance, and remaining quota. This endpoint uses API key authentication.
This endpoint requires a valid API key in the request header. The usage information is specific to the organization associated with the API key. See Pricing for the Free allowance, subscription terms, and credit purchases. Check the billing dashboard for your plan allowance and purchased credit balance.
This endpoint is served from a different base URL than the document-processing APIs:
https://prod.visionapi.unsiloed.ai/org/get_usage returns 404.

Authentication

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

Response

string
Unique identifier for your organization
string
Name of your organization
number
Credits used against your organization’s reported usage allowance
number
Current usage allowance (credits) reported for your organization
number
Credits remaining in your organization’s reported quota. Calculated as: usage_limit - current_usage
string
Date of the last billing cycle reset reported by the API, in ISO 8601 format (YYYY-MM-DD).

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

Credits used against your organization's reported usage allowance

usage_limit
number

Current usage allowance (credits) reported for your organization

remaining_quota
number

Credits remaining in your organization's reported quota

last_billed_date
string<date>

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