Skip to main content
AI Runtime & Governance

Read FinanceGPT Managed AI usage, forecast and utilization for the active workspace

GET /ai-credits/usage

Contract

Authentication
Bearer credential required
Required scope
ai:credits:read
Status
Published

Parameters

Name Location Type Required Description
period query string No

Code examples

These examples compose a request only. Public reference pages never transmit your credential or execute the operation.

curl

curl -X GET \
  -H "Authorization: Bearer $FINANCEGPT_API_KEY" \
  -H "Accept: application/json"
  "https://financegpt.dev/api/v2/ai-credits/usage"

javascript

const response = await fetch("https:\/\/financegpt.dev\/api\/v2\/ai-credits\/usage", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${FINANCEGPT_API_KEY}`,
    Accept: 'application/json',
  },
});
const data = await response.json();

python

import json
import os
import requests

response = requests.request(
    'GET',
    'https://financegpt.dev/api/v2/ai-credits/usage',
    headers={
        'Authorization': 'Bearer ' + os.environ['FINANCEGPT_API_KEY'],
        'Accept': 'application/json',
    },
)
response.raise_for_status()
print(response.json())

php

<?php
$ch = curl_init('https://financegpt.dev/api/v2/ai-credits/usage');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer '.getenv('FINANCEGPT_API_KEY'),
        'Accept: application/json',
    ],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Responses

Status Description
200 Workspace usage totals

Authority boundary

A developer credential proves application identity and permits only its scopes. It does not grant model promotion, policy override, QLM rebinding, or Financial Actions execution authority unless those separate controls are satisfied.

ai:credits:read

Machine-readable sources