---
title: "Retrieve your balance"
method: GET
path: "/v1/credits"
tags: ["Credits"]
---

# Retrieve your balance

`GET /v1/credits`

## Request

- Base URL: `https://api.tryleap.ai`
- URL: `https://api.tryleap.ai/v1/credits`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

What your workspace can spend now, what running generations hold, whether auto top-up will add more when it runs low, and whether it got the welcome credit, which workspaces made since 2026-10-14 don't get. Add credits and turn on auto top-up at `add_credits_url`; your first top-up has no card fee, and none from $20.

Needs an API key with the `generations:read` scope.

## Response `200`

The balance.

- Credits: Your workspace's balance.
  - `object` 'credits', required
  - `available_usd` string, required: What you can spend now: your balance minus what running generations hold, as an exact decimal string in US dollars.
  - `held_usd` string, required: What generations still running hold.
  - `welcome` object, required: The one-time welcome credit that workspaces made before 2026-10-14 could get.
    - `status` 'granted' | 'withheld' | 'none', required: `granted` when your workspace got the welcome credit; `withheld` when it was due one but its sign-up went past the limits that stop sign-up farms, so none will come; `none` when it isn't a workspace that gets one. Workspaces made since 2026-10-14 get no welcome credit and read `none`.
    - `amount_usd` string, required: How much was granted, as an exact decimal string in US dollars; `0.000000` unless `granted`.
  - `auto_top_up` object, required: Auto top-up, which keeps your keys running when the balance runs low. Turn it on at `add_credits_url`.
    - `enabled` boolean, required: Whether auto top-up is on: when the balance falls below `threshold_usd`, it adds `amount_usd` from the card your last top-up saved.
    - `threshold_usd` string, nullable, required: The balance it tops up below, as an exact decimal string in US dollars; null until it is set.
    - `amount_usd` string, nullable, required: What each automatic top-up adds, as an exact decimal string in US dollars; null until it is set. From $20 there is no card fee.
  - `add_credits_url` string, required: Where a person adds credit and turns on auto top-up, in the studio.

## Other responses

- `400`: `conflicting_credentials`
- `401`: `authentication_required`
- `403`: `permission_denied`
- `429`: `rate_limit_exceeded`

---

[API](https://skmtc.dev/tryleap/apis/leap-api.md) · [All operations](https://skmtc.dev/tryleap/apis/leap-api/llms.txt) · [OpenAPI document](https://skmtc.dev/tryleap/apis/leap-api/revisions/c01f98d3e835?raw)