Get AI usage

Returns monthly AI calls, active limits, platform limits, period timestamps and usage cost in cents.

GET https://app.upfour.io/v1/organization/ai-usage

Authorization

AuthorizationA pls_ key. It stays in this browser tab. Needs organization.read.

Sent directly from your browser to https://app.upfour.io/v1. Mutating calls get an automatic Idempotency-Key when the field is empty.

Request

Responsenot sent yet

Fill in a key and press Send request (⌘↵).
The answer appears here.

scope organization.read stable returns 200

Returns

A successful request returns 200 with application/json.

Response fields 1 top-level fields

Field Type Description

data AIUsageSummary

AIUsageSummary · 8 fields

Field	Type	Description
`call_cap`	integer	The monthly call limit in force: the Company's own value, never above platform_call_cap.
`calls`	integer
`cap_cents`	integer	The monthly budget in force: the Company's own value, never above platform_cap_cents.
`period_resets_at`	string (date-time)
`period_started_at`	string (date-time)
`platform_call_cap`	integer
`platform_cap_cents`	integer
`used_cents`	integer	This month's AI usage in cents, at the price the Company pays.

Errors

Only the errors this operation can return. Every error uses the same envelope.

Status	Code	Meaning
402	`ai_billing_blocked`	AI features are switched off because the Company has no active credit. When: An AI summary or postmortem request while the Company has no active credit. Fix: Top up the credit, then retry.
422	`ai_budget_above_platform_limit`	The monthly AI budget is above the platform limit. When: Saving an AI budget larger than the platform allows; details.limit gives the maximum. Fix: Set a budget at or below details.limit.
422	`ai_call_cap_above_platform_limit`	The monthly AI call cap is above the platform limit. When: Saving an AI call cap larger than the platform allows; details.limit gives the maximum. Fix: Set a cap at or below details.limit.
400	`bad_request`	The request is malformed or fails validation.
409	`conflict`	The request conflicts with the current state.
404	`not_found`	The requested resource does not exist or is outside the caller's scope.
403	`permission_denied`	The credentials do not permit this action.
503	`service_unavailable`	The service or a required dependency is temporarily unavailable.

Every call can also return unauthorized (401), rate_limit_exceeded (429) or internal_error (500 / 502). See Responses and errors.

import os import requests res = requests.get( "https://app.upfour.io/v1/organization/ai-usage", headers={"Authorization": f"Bearer {os.environ['UP4_API_KEY']}"}, ) print(res.status_code, res.json())

package main import ( "fmt" "io" "net/http" "os" ) func main() { req, _ := http.NewRequest("GET", "https://app.upfour.io/v1/organization/ai-usage", nil) req.Header.Set("Authorization", "Bearer "+os.Getenv("UP4_API_KEY")) res, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer res.Body.Close() out, _ := io.ReadAll(res.Body) fmt.Println(res.StatusCode, string(out)) }

<?php $ch = curl_init("https://app.upfour.io/v1/organization/ai-usage"); curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => [ "Authorization: Bearer " . getenv("UP4_API_KEY"), ], ]); $response = curl_exec($ch); echo curl_getinfo($ch, CURLINFO_RESPONSE_CODE), " ", $response, "\n"; curl_close($ch);

{ "data": { "call_cap": 100, "calls": 2, "cap_cents": 500, "period_resets_at": "2026-10-31T16:55:00Z", "period_started_at": "2026-09-30T16:55:00Z", "platform_call_cap": 1000, "platform_cap_cents": 4000, "used_cents": 2 } }