Get your credit balance

curl https://api.tokenpath.ai/v1/me/credits \
  -H "Authorization: Bearer $TOKENPATH_API_KEY"

import os
import httpx

balance = httpx.get(
    "https://api.tokenpath.ai/v1/me/credits",
    headers={"Authorization": f"Bearer {os.environ['TOKENPATH_API_KEY']}"},
).json()

if balance["available_tokens"] < 1_000_000:
    print("Fewer than 1M tokens left. Top up at platform.tokenpath.ai.")

{
  "customer_id": "cus_abc123",
  "available_tokens": 9985000,
  "reserved_tokens": 1500
}

GET https://api.tokenpath.ai/v1/me/credits

Returns your prepaid token balance. Check it before a large batch, or use it to alert yourself before you run out. Requires the usage:read scope.

Response

string

Your account ID.

integer

Tokens you can spend now. When a request starts, its estimated cost moves from here to reserved_tokens.

integer

Tokens held by requests that are still running. When each request finishes, its hold is either charged (on success) or returned to available_tokens (on failure).

curl https://api.tokenpath.ai/v1/me/credits \
  -H "Authorization: Bearer $TOKENPATH_API_KEY"

import os
import httpx

balance = httpx.get(
    "https://api.tokenpath.ai/v1/me/credits",
    headers={"Authorization": f"Bearer {os.environ['TOKENPATH_API_KEY']}"},
).json()

if balance["available_tokens"] < 1_000_000:
    print("Fewer than 1M tokens left. Top up at platform.tokenpath.ai.")

{
  "customer_id": "cus_abc123",
  "available_tokens": 9985000,
  "reserved_tokens": 1500
}

See Credits and billing for pricing and how holds work.

Errors

In addition to the authentication errors:

Status	Code	Meaning
`404`	`balance_not_found`	Account setup did not finish. Email [email protected].

curl https://api.tokenpath.ai/v1/me/credits \
  -H "Authorization: Bearer $TOKENPATH_API_KEY"

import os
import httpx

balance = httpx.get(
    "https://api.tokenpath.ai/v1/me/credits",
    headers={"Authorization": f"Bearer {os.environ['TOKENPATH_API_KEY']}"},
).json()

if balance["available_tokens"] < 1_000_000:
    print("Fewer than 1M tokens left. Top up at platform.tokenpath.ai.")

{
  "customer_id": "cus_abc123",
  "available_tokens": 9985000,
  "reserved_tokens": 1500
}

Overview

Endpoints

Get your credit balance

Response

Errors

​Response

​Errors

Response

Errors