메인 콘텐츠로 건너뛰기
GET
/
v1
/
balance
curl --request GET \
  --url 'https://api.apimart.ai/v1/balance' \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "remain_balance": 10.5,
  "used_balance": 2.3,
  "unlimited_quota": false
}

Documentation Index

Fetch the complete documentation index at: https://docs.apimart.ai/llms.txt

Use this file to discover all available pages before exploring further.

현재 API 키(토큰)의 남은 잔액과 사용된 잔액을 조회합니다. 이 엔드포인트는 단일 토큰의 사용량을 모니터링하는 데 사용됩니다. 
curl --request GET \
  --url 'https://api.apimart.ai/v1/balance' \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "remain_balance": 10.5,
  "used_balance": 2.3,
  "unlimited_quota": false
}

​
인증

​
Authorization
string
필수
모든 API 엔드포인트에는 Bearer Token 인증이 필요합니다API 키 받기:API 키 관리 페이지에서 API 키를 받으세요요청 헤더에 추가:
Authorization: Bearer YOUR_API_KEY

​
엔드포인트

GET /v1/balance
GET /balance
두 엔드포인트는 동일한 기능을 가지고 있습니다. 둘 중 하나를 사용할 수 있습니다.

​
응답

​
success
boolean
요청 성공 여부
​
message
string
오류 메시지 (실패 시에만 반환)
​
remain_balance
float
토큰 남은 잔액 (성공 시 반환). unlimited_quota가 true일 때 값은 -1입니다
​
used_balance
float
토큰 사용된 잔액 (성공 시 반환)
​
unlimited_quota
boolean
토큰이 무제한인지 여부. true는 무제한, false는 제한됨을 의미합니다

​
사용 사례

  • 단일 API 키의 소비 상황 모니터링
  • 애플리케이션에서 현재 토큰 잔액 표시
  • 잔액이 임계값 이하로 떨어지면 알림 설정
잔액 단위 정보잔액 값의 단위는 시스템 설정에 따라 다릅니다:
  • USD - 미국 달러
  • CNY - 중국 위안
  • Tokens - 토큰 수
무제한 토큰토큰이 무제한으로 설정된 경우:
  • unlimited_quota 필드는 true를 반환합니다
  • remain_balance 필드는 -1을 반환합니다
  • 해당 토큰은 제한 없이 무제한으로 사용할 수 있습니다

​
일반적인 오류

오류 메시지원인해결 방법
Authorization 헤더 없음Authorization 헤더가 제공되지 않음Authorization: Bearer sk-xxxxx 헤더 추가
토큰 정보 가져오기 실패토큰이 존재하지 않거나 삭제됨토큰 키가 올바른지 확인
보안 참고 사항API 키는 비밀번호와 같습니다. 안전하게 보관하고 다른 사람과 공유하지 마세요. 프로덕션에서는 항상 HTTPS를 사용하세요.