> For the complete documentation index, see [llms.txt](https://docs.altum.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.altum.ai/english/developers/usage-api.md).

# 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.

{% hint style="info" %}
**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](https://app.slack.com/ontwikkelaars/credittarieven).
{% endhint %}

#### 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.

{% hint style="info" %}
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.
{% endhint %}

#### 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.

{% hint style="info" %}
There is a 60s latency window between changes in your credit and its presence in the Usage API.
{% endhint %}

***

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

<mark style="color:blue;">`GET`</mark> `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<mark style="color:red;">\*</mark> | string | Valid API key    |
| Content-Type                                | string | application/json |

{% tabs %}
{% tab title="200: OK Successful" %}
{\
"interactivereference-api": "6", \
"rebuildapi": "1", \
"objectdataapi": "1" \
}
{% endtab %}

{% tab title="403: Forbidden Feature not enabled on your account" %}
{ "message": "Forbidden" }
{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Sample Request" %}

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

{% endtab %}

{% tab title="Sample Response" %}

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

{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.altum.ai/english/developers/usage-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.