Browse the API reference

Get Organization Usage

get/v1/orgs/{org_id}/usage

Part of Org Usage.

Aggregated across all graphs in the org. Use the days query param to control the lookback window (default 30).

Authentication

Authenticate in any one of these ways — not all of them:

  • API key in the X-API-Key header.
  • Bearer token in the Authorization header.

Path parameters

NameTypeDescription
org_idrequiredstringOrg Id

Query parameters

NameTypeDescription
daysoptionalintegerDays

Default: 30

Example request

curl
curl -X GET "https://api.robosystems.ai/v1/orgs/{org_id}/usage" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY"

Responses

200 Successful Response

FieldTypeDescription
org_idrequiredstring
period_daysrequiredinteger
start_daterequiredstring (date-time)
end_daterequiredstring (date-time)
summaryrequiredOrgUsageSummary

Organization usage summary.

OrgUsageSummary fields
FieldTypeDescription
total_credits_usedrequirednumber
total_ai_operationsrequiredinteger
total_storage_gbrequirednumber
daily_avg_creditsrequirednumber
projected_monthly_creditsrequirednumber
credits_limitrequiredinteger
storage_limit_gbrequiredinteger
graph_detailsrequiredobject[]
daily_trendrequiredobject[]
StatusMeaning
400Invalid request
401Authentication required
403Access denied
404Resource not found
422Validation Error
429Rate limit exceeded
500Internal server error