API 키 잔액 조회 | ToAPIs Documentation

GET

/api/v1/api-keys/{api_key_id}/balance

중국 본토 사용자 안내: 중국 본토 사용자는 https://api.toapis.cn 를 API 엔드포인트(Base URL)로 사용해 주세요. 본 문서의 예시에서 https://api.toapis.com 을 https://api.toapis.cn 로 바꿔 주세요.

동작

지정 키의 잔여 할당량 스냅샷을 읽어 얼마나 더 쓸 수 있는지 확인합니다. 비활성·만료·소진·소프트 삭제된 키도 읽을 수 있습니다. 타인 소유이거나 존재하지 않는 키는 404입니다.

반환하는 것은 데이터베이스에 저장된 잔액 스냅샷으로 실시간 계산 값이 아닙니다: 무제한 키의 잔여 금액은 null, 사용 금액은 정상 반환됩니다. 일/월 한도의 실시간 사용 카운터는 이 엔드포인트에서 읽지 않습니다. 호출 과금은 배치로 데이터베이스에 기록되므로 배치가 반영되기 전에는 실제 사용량보다 약간 늦은 값을 읽을 수 있습니다.

인증

Authorizationstring헤더필수

Bearer YOUR_SYSTEM_ACCESS_TOKEN을 사용합니다. 모델 키는 허용하지 않으며 X-User-Id는 필요하지 않습니다. 공통 규칙은 시작하기를 참조하세요.

요청 매개변수

api_key_idstring경로필수

소유한 일반 모델 키의 십진 문자열 ID. sk- 비밀 키가 아닙니다.

본문과 쿼리 매개변수는 허용하지 않습니다.

요청 예제

요청 예시

curl --request GET \
  --url 'https://api.toapis.com/api/v1/api-keys/43/balance' \
  --header 'Authorization: Bearer YOUR_SYSTEM_ACCESS_TOKEN'

import requests

response = requests.get(
    "https://api.toapis.com/api/v1/api-keys/43/balance",
    headers={"Authorization": "Bearer YOUR_SYSTEM_ACCESS_TOKEN"},
    timeout=30,
)
response.raise_for_status()
print(response.json())

const response = await fetch("https://api.toapis.com/api/v1/api-keys/43/balance", {
  method: "GET",
  headers: { Authorization: "Bearer YOUR_SYSTEM_ACCESS_TOKEN" },
  signal: AbortSignal.timeout(30_000),
});
if (!response.ok) {
  throw new Error(`HTTP ${response.status}: ${await response.text()}`);
}
console.log(await response.json());

응답 필드

예제는 가상 데이터입니다. 메타데이터는 키 상세, 공통 응답과 오류는 시작하기를 참조하세요.

data.api_key_idstring

키 ID.

data.statusstring

현재 상태, deleted 포함.

data.unlimitedboolean

무제한 할당량 여부.

data.remaining_creditsstring | null

잔여 credits, 무제한이면 null.

data.remaining_usdstring | null

잔여 USD 환산액, 무제한이면 null.

data.used_creditsstring

누적 사용 credits.

data.used_usdstring

누적 사용 USD 환산액.

data.daily_limit_creditsstring | null

일일 credits 한도, 무제한이면 null.

data.monthly_limit_creditsstring | null

월간 credits 한도, 무제한이면 null.

data.credits_per_usdstring

1 USD당 credits.

응답 예제

응답 예시

{
  "code": 0,
  "message": "",
  "data": {
    "api_key_id": "43",
    "status": "enabled",
    "unlimited": false,
    "remaining_credits": "500",
    "remaining_usd": "5",
    "used_credits": "100",
    "used_usd": "1",
    "daily_limit_credits": null,
    "monthly_limit_credits": null,
    "credits_per_usd": "100"
  }
}