GET /auth/credits/ledger
Query immutable final credit balance movements. Usage audit explains request outcomes; the credits ledger explains signed balance changes. Negative amount_credits values consume credits and positive values grant credits.
REST API overview · OpenAPI JSON · OpenAPI YAML
| Stability | Authentication | Cost | Operation ID |
|---|---|---|---|
| Published | Bearer API key | Free | get_credits_ledger_api_v1_auth_credits_ledger_get |
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
start_date | query | No | string | null | — |
end_date | query | No | string | null | — |
entry_type | query | No | string | null | — |
scope | query | No | string | null | — |
page | query | No | integer | — |
page_size | query | No | integer | — |
min_credits | query | No | number | null | — |
max_credits | query | No | number | null | — |
direction | query | No | string | — |
bucket | query | No | string | null | — |
summary | query | No | boolean | — |
limit | query | No | integer | null | — |
This operation has no JSON request body.
curl --request GET \
--url "https://qveris.ai/api/v1/auth/credits/ledger" \
--header "Authorization: Bearer $QVERIS_API_KEY"
const response = await fetch("https://qveris.ai/api/v1/auth/credits/ledger", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.QVERIS_API_KEY}`,
},
})
if (!response.ok) throw new Error(`QVeris request failed: ${response.status}`)
console.log(await response.json())
import os
import requests
response = requests.request(
"GET",
"https://qveris.ai/api/v1/auth/credits/ledger",
headers={"Authorization": f"Bearer {os.environ['QVERIS_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
| Status | Meaning | Schema |
|---|---|---|
200 | Successful Response | APIResponse_CreditsLedgerResponse_ |
400 | Invalid ledger query | APIResponse_dict_ |
422 | Validation Error | HTTPValidationError |
{
"status": "success",
"message": "Credits ledger retrieved successfully",
"status_code": 0,
"data": {
"items": [
{
"id": "led_01HZX9R39K6QZ",
"entry_type": "consume_tool_execute",
"amount_credits": -5,
"source_system": "qveris_website",
"source_ref_type": "execute_history",
"source_ref_id": "2b7f7c4a-9f3a-4f61-8b59-3a983a8192a0",
"execution_id": "exec_01HZX9R2R4S2E",
"pre_settlement_bill": {
"execution_id": "exec_01HZX9R2R4S2E",
"summary": "5 credits per successful request",
"list_amount_credits": 5
},
"settlement_result": {
"settled_amount_credits": 5
},
"balance_before": {
"total_available_credits": 995
},
"balance_after": {
"total_available_credits": 990
},
"description": "Tool execution charge",
"created_at": "2026-05-16T08:30:13Z"
}
],
"total": 1,
"page": 1,
"page_size": 50,
"summary": null
}
}
POST Discover capabilities · POST Inspect capabilities · POST Probe a capability · POST Call a capability
Was this page helpful?