Usage API

Usage API is a utility API that helps to keep track of your used Altum credits.

The Usage API gives you insight into your API usage: the number of calls made per API within a selected period. This is useful for monitoring usage, validating integrations, and setting up call-based checks.

Note: number of calls, not credits The Usage API reports the number of calls per API, not the number of credits used or your remaining credit balance. Under the credit model, each API has its own credit cost per call. To convert calls into credits, multiply the number of calls by the credit rate for the relevant API. See Credit rates.

Name change: from Credit API to Usage API

This API was previously called the Credit API. In the new platform, a “credit” is a billing unit (1 credit = €0.05), while this API returns the number of calls. To make this distinction clearer, we renamed it to the Usage API.

The endpoint itself does not change. The /credit path remains unchanged and fully supported, so existing integrations, including Enterprise checks, will continue to work without any changes. No action is required.

A GET Request

A GET Request to the Usage API will return a JSON response showing your used credits, categorized into API names since 24 hours ago. By adding a time parameter, you can specify the time range of the request in hours.

There is a 60s latency window between changes in your credit and its presence in the Usage API.

---

Make GET Request to the API to receive your used credit for 24 hours. Specify your time range with the time query parameter

GET https://api.altum.ai/credit

Query Parameters

Name	Type	Description
time	integer	Time range in hours. Eg. 90

Headers

Name	Type	Description
x-api-key*	string	Valid API key
Content-Type	string	application/json

200: OK Successful

{ "interactivereference-api": "6", "rebuildapi": "1", "objectdataapi": "1" }

403: Forbidden Feature not enabled on your account

{ "message": "Forbidden" }

Sample Request

https://api.altum.ai/credit
?time=40

Sample Response

{
	"interactivereference-api": 1307,
	"avmapi": 671,
	"wozapi": 209,
	"sustainabilityapi": 85,
	"energylabelapi": 390
}