---
title: "Get chat usage"
method: GET
path: "/v1/usage/chat"
tags: ["Usage"]
---

# Get chat usage

`GET /v1/usage/chat`

## Request

- Base URL: `https://api.hotapi.ai`
- URL: `https://api.hotapi.ai/v1/usage/chat`
- Auth: HTTP bearer

Chat completion billing for the organization, from the credit ledger (chat calls do not create task rows). `data` is the most recent ledger rows (kind: est = upfront charge, refund = estimate trued up to actual, failed = full refund). `summary` aggregates the whole filtered range: calls counts upfront charges, net_credits is charged minus returned.

## Query parameters

- `from` string
- `to` string
- `limit` unknown

## Response `200`

Chat completion billing from the credit ledger, most recent first.

- ChatUsage: Chat completion billing from the credit ledger, most recent first.
  - `data` object[], required
    - `id` string, required
    - `created_at` integer, required: Unix seconds.
    - `model` string, required: Chat model billed.
    - `kind` union, required: est = upfront charge, refund = estimate trued up to actual, failed = call failed (full refund).
      - 'est'
      - 'refund'
      - 'failed'
      - 'other'
    - `credits` integer, required: Credits moved by this row: positive = charged, negative = returned to the wallet.
  - `summary` object, required
    - `calls` integer, required: Chat calls started (upfront charges).
    - `refunded_calls` integer, required: Calls whose estimate was trued up.
    - `failed_calls` integer, required: Calls that failed and were fully refunded.
    - `charged_credits` integer, required: Total upfront charges.
    - `returned_credits` integer, required: Total refunds returned to the wallet.
    - `net_credits` integer, required: charged minus returned.

## Other responses

- `400`: Standard error envelope returned by every error response (OpenAI-style).
- `401`: Standard error envelope returned by every error response (OpenAI-style).
- `429`: Standard error envelope returned by every error response (OpenAI-style).

---

[API](https://skmtc.dev/hotapi/apis/hotapi-gateway.md) · [All operations](https://skmtc.dev/hotapi/apis/hotapi-gateway/llms.txt) · [OpenAPI document](https://skmtc.dev/hotapi/apis/hotapi-gateway/revisions/9b6578b0c389?raw)