Skip to content
UltimateTeam.ai Docs

Get Credit Usage

GET
/api/v1/admin/credit-usage
curl --request GET \
  --url 'https://api.ultimateteam.ai/api/v1/admin/credit-usage?window_hours=24' \
  --header 'X-API-Key: <X-API-Key>'

Per-tool credit usage breakdown for the trailing window.

Args: window_hours: How many trailing hours to aggregate. tenant_id: Optional tenant filter. user: Authenticated platform operator. session: Async DB session.

Returns: :class:CreditUsagePayload with one row per tool_name.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
window_hours
Window Hours

Trailing window in hours (1 to 720 = 30 days).

integer
default: 24 >= 1 <= 720

Trailing window in hours (1 to 720 = 30 days).

tenant_id
Any of:
string

Optional tenant filter, still subject to request RLS. Requires platform-operator authority even when omitted.

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
CreditUsagePayload

Frozen response shape for /admin/credit-usage.

object
generated_at
required
Generated At
string
grand_total_credits
required
Grand Total Credits
integer
grand_total_invocations
required
Grand Total Invocations
integer
rows
required
Rows
Array<object>
CreditUsageRow

One row of the per-tool credit breakdown.

object
canonical_cost
required
Canonical Cost

Documented per-call cost from src.core.agent_tools.credit_costs. Zero when the tool is not in the canonical table (legacy / dynamically-priced).

integer
credits_consumed
required
Credits Consumed
integer
error_count
required
Error Count
integer
invocation_count
required
Invocation Count
integer
success_count
required
Success Count
integer
tool_name
required
Tool Name
string
tenant_id
required
Any of:
string
window_hours
required
Window Hours
integer
Examplegenerated
{
  "generated_at": "example",
  "grand_total_credits": 1,
  "grand_total_invocations": 1,
  "rows": [
    {
      "canonical_cost": 1,
      "credits_consumed": 1,
      "error_count": 1,
      "invocation_count": 1,
      "success_count": 1,
      "tool_name": "example"
    }
  ],
  "tenant_id": "example",
  "window_hours": 1
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}