Get current Budget utilization

curl --request GET \
  --url https://api.checkfu.com/v1/budgets/{id}/utilization \
  --header 'Authorization: Bearer <token>' \
  --header 'checkfu-version: <checkfu-version>'

import requests

url = "https://api.checkfu.com/v1/budgets/{id}/utilization"

headers = {
    "checkfu-version": "<checkfu-version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'checkfu-version': '<checkfu-version>', Authorization: 'Bearer <token>'}
};

fetch('https://api.checkfu.com/v1/budgets/{id}/utilization', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.checkfu.com/v1/budgets/{id}/utilization",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "checkfu-version: <checkfu-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.checkfu.com/v1/budgets/{id}/utilization"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("checkfu-version", "<checkfu-version>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.checkfu.com/v1/budgets/{id}/utilization")
  .header("checkfu-version", "<checkfu-version>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/budgets/{id}/utilization")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "budget": {
    "id": "<string>",
    "workspace_id": "<string>",
    "scope": {
      "kind": "workspace",
      "agent_definition_id": "<unknown>",
      "principal_id": "<unknown>",
      "surface_scope_id": "<unknown>",
      "automation_id": "<unknown>",
      "session_id": "<unknown>"
    },
    "metric": "model_tokens",
    "window": {
      "kind": "rolling",
      "duration_seconds": 1
    },
    "soft_threshold": {
      "limit": 1,
      "action": "notify"
    },
    "hard_threshold": {
      "limit": 1,
      "breach_action": "block_admission"
    },
    "state": "active",
    "version": 1,
    "created_at": "<string>",
    "updated_at": "<string>"
  },
  "as_of": "<string>",
  "window_started_at": "<string>",
  "settled_usage": 1,
  "remaining_to_hard_limit": 1,
  "soft_threshold_reached": true,
  "hard_threshold_reached": true
}

{
  "error": {
    "type": "validation.malformed",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-malformed"
  }
}

{
  "error": {
    "type": "auth.invalid_key",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-invalid-key"
  }
}

{
  "error": {
    "type": "auth.disabled_tenancy",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
  }
}

{
  "error": {
    "type": "validation.not_found",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-not-found"
  }
}

{
  "error": {
    "type": "budget.exceeded",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#budget-exceeded"
  }
}

{
  "error": {
    "type": "runtime.internal",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#runtime-internal"
  }
}

Get current Budget utilization

Returns one timestamped snapshot of committed UsageLedger consumption in this Budget’s current window, using the exact Budget configuration/version, scope, metric, inclusive window, safe-integer, and unpriced-spend rules used by enforcement. settled_usage excludes active reservations, queue state, quarantine escrow, Workspace quotas, billing credits, and projected work. This is observability only; never use it as admission preflight or as a statement of capacity available to spend.

Checkfu support posture: alpha; hosted. Required evidence journey: governance-registry. Deployment-specific readiness and the latest proven release are available from GET /v1/support/capabilities.

GET

budgets

{id}

utilization

Get current Budget utilization

curl --request GET \
  --url https://api.checkfu.com/v1/budgets/{id}/utilization \
  --header 'Authorization: Bearer <token>' \
  --header 'checkfu-version: <checkfu-version>'

import requests

url = "https://api.checkfu.com/v1/budgets/{id}/utilization"

headers = {
    "checkfu-version": "<checkfu-version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'checkfu-version': '<checkfu-version>', Authorization: 'Bearer <token>'}
};

fetch('https://api.checkfu.com/v1/budgets/{id}/utilization', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.checkfu.com/v1/budgets/{id}/utilization",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "checkfu-version: <checkfu-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.checkfu.com/v1/budgets/{id}/utilization"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("checkfu-version", "<checkfu-version>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.checkfu.com/v1/budgets/{id}/utilization")
  .header("checkfu-version", "<checkfu-version>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/budgets/{id}/utilization")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "budget": {
    "id": "<string>",
    "workspace_id": "<string>",
    "scope": {
      "kind": "workspace",
      "agent_definition_id": "<unknown>",
      "principal_id": "<unknown>",
      "surface_scope_id": "<unknown>",
      "automation_id": "<unknown>",
      "session_id": "<unknown>"
    },
    "metric": "model_tokens",
    "window": {
      "kind": "rolling",
      "duration_seconds": 1
    },
    "soft_threshold": {
      "limit": 1,
      "action": "notify"
    },
    "hard_threshold": {
      "limit": 1,
      "breach_action": "block_admission"
    },
    "state": "active",
    "version": 1,
    "created_at": "<string>",
    "updated_at": "<string>"
  },
  "as_of": "<string>",
  "window_started_at": "<string>",
  "settled_usage": 1,
  "remaining_to_hard_limit": 1,
  "soft_threshold_reached": true,
  "hard_threshold_reached": true
}

{
  "error": {
    "type": "validation.malformed",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-malformed"
  }
}

{
  "error": {
    "type": "auth.invalid_key",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-invalid-key"
  }
}

{
  "error": {
    "type": "auth.disabled_tenancy",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
  }
}

{
  "error": {
    "type": "validation.not_found",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-not-found"
  }
}

{
  "error": {
    "type": "budget.exceeded",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#budget-exceeded"
  }
}

{
  "error": {
    "type": "runtime.internal",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#runtime-internal"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

checkfu-version

enum<string>

required

Available options:

2026-08-24

Path Parameters

string

required

Pattern: ^bgt_[0-9a-f]{32}$

Response

A timestamped current-window Budget observation computed from committed UsageLedger facts.

budget

object

required

Show child attributes

as_of

string

required

A canonical UTC ISO-8601 timestamp with millisecond precision.

Maximum string length: 24

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$

window_started_at

string

required

A canonical UTC ISO-8601 timestamp with millisecond precision.

Maximum string length: 24

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$

settled_usage

integer

required

Required range: x >= 0

remaining_to_hard_limit

integer

required

Required range: x >= 0

soft_threshold_reached

boolean

required

hard_threshold_reached

boolean

required

Developer tools

Canonical tables

Author protocols

Generated HTTP API

Get current Budget utilization

Authorizations

Headers

Path Parameters

Response