Sign in

v1

latestOpenAPI 3.0.3BSL2026-07-17133415718.8 KB
Organization

Get Organization Usage

Fetch the current usage specification of an organization by its id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.

post/api/organization/usage/{organization_id}

Path parameters

organization_idstring uuid required

The id of the organization you want to fetch the usage of.

Headers

TR-Organizationstring uuid required

The organization id to use for the request

Request body

v1_usageboolean nullable

Example request

{
  "date_range": {
    "gt": "2021-01-01 00:00:00.000",
    "gte": "2021-01-01 00:00:00.000",
    "lt": "2021-01-01 00:00:00.000",
    "lte": "2021-01-01 00:00:00.000"
  }
}

Response

The current usage of the specified organization

bytes_ingestedinteger required
chunk_countinteger required
current_months_message_countinteger required
dataset_countinteger required
events_ingestedinteger required
file_storageinteger required
message_countinteger required
message_tokensinteger required
ocr_pages_ingestedinteger required
search_countinteger required
search_tokensinteger required
tokens_ingestedinteger required
user_countinteger required
website_pages_scrapedinteger required