Credit API

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

Credit API is only available to Prepaid users. Enterprise customers can utilize this upon request.

A GET Request to the Credit 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 Credit 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 seconds. Eg. 90

Headers

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

200: OK Successful

403: Forbidden Feature not enabled on your account

400: Bad Request Bad Request

401: Unauthorized Wrong API Key

422: Unprocessable Entity Parameter may be wrong

Sample Request

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

Sample Response

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