API 레퍼런스
로그인
본문으로 건너뛰기

잔액 조회

조직 지갑의 잔액, 사용 가능 잔액, 낮은 잔액 표시, 충전 링크를 돌려줍니다

GET /v1/balance

인증

방식허용조건
API 키 (Authorization: Bearer xci_live_…)가능키 권한 read (run 키도 가능)
콘솔 세션 쿠키가능조직 역할 owner, admin, developer
  • API 키는 자기 조직을 읽습니다, 콘솔 세션은 org_id를 보냅니다

참고 서버 구현(2026-10-12 dev 기준)이 계약 초안과 다른 점

  • 이 엔드포인트는 계약 초안에만 있고 아직 서버에 없습니다, 지금 호출하면 404 not_found입니다 (server/ 어디에도 /v1/balance 핸들러가 없음), CLI의 xenocast credits와 MCP credits 도구가 이 경로를 부르므로 서버가 붙기 전에는 같은 404를 받습니다

매개변수

이름위치타입필수설명
org_id쿼리string콘솔 세션은 필수, API 키는 무시(키의 조직)

응답

200

필드타입항상설명
organization_idstring항상조직 ID
balance_micro_usdinteger항상원장 합계 잔액(µUSD), 최소 0
balance_usdstring항상같은 금액의 USD 문자열(소수 6자리), 형식 ^-?[0-9]+\.[0-9]{6}$
available_micro_usdinteger항상만료되지 않은 로트 합에서 실행 중인 잡이 이미 쓴 금액을 뺀 값, 최소 0
available_usdstring항상같은 금액의 USD 문자열(소수 6자리), 형식 ^-?[0-9]+\.[0-9]{6}$
reserved_micro_usdinteger항상실행 중인 잡이 이미 쓴 금액, 최소 0
reserved_usdstring항상같은 금액의 USD 문자열(소수 6자리), 형식 ^-?[0-9]+\.[0-9]{6}$
rate_micro_usd_per_mininteger항상지금 적용되는 분당 요율(µUSD)
lowboolean항상사용 가능 잔액이 낮은 잔액 기준 아래인지
low_threshold_micro_usdinteger낮은 잔액 기준, 최소 0
low_threshold_usdstring낮은 잔액 기준(USD), 형식 ^-?[0-9]+\.[0-9]{6}$
next_expiryobject다음에 만료될 로트의 시각과 남은 금액, 없으면 null, null 가능
next_expiry.expires_attimestamp만료 시각
next_expiry.remaining_micro_usdinteger금액(µUSD 정수), 최소 0
next_expiry.remaining_usdstring같은 금액의 USD 문자열(소수 6자리), 형식 ^-?[0-9]+\.[0-9]{6}$
topup_urlstring항상콘솔 충전 페이지, 결제 토큰은 없고 로그인이 필요합니다
{
  "organization_id": "org_7Kq2m9ZtP3",
  "balance_micro_usd": 20000000,
  "balance_usd": "20.000000",
  "available_micro_usd": 19881200,
  "available_usd": "19.881200",
  "reserved_micro_usd": 118800,
  "reserved_usd": "0.118800",
  "rate_micro_usd_per_min": 39600,
  "low": false,
  "low_threshold_micro_usd": 1188000,
  "low_threshold_usd": "1.188000",
  "next_expiry": {
    "expires_at": "2027-10-12T03:11:05Z",
    "remaining_micro_usd": 19881200,
    "remaining_usd": "19.881200"
  },
  "topup_url": "https://xenoci.com/console/topup?org=org_7Kq2m9ZtP3"
}

오류

HTTP코드다시 시도뜻
400invalid_request아니오본문이나 쿼리가 검증에 실패했습니다, error.details.fields에 문제 필드가 있습니다
401api_key_required아니오API 키 엔드포인트에 Authorization: Bearer 헤더가 없습니다
401api_key_revoked_leaked아니오공개 유출 신고로 자동 폐기된 키입니다, 새 키를 발급하세요
401invalid_api_key아니오모르는 키이거나 폐기, 만료, 체크섬 불일치입니다(종료된 xeno_ 접두사 포함)
401session_required아니오콘솔 엔드포인트를 유효한 콘솔 세션 쿠키 없이 불렀습니다
403insufficient_permission아니오역할이나 키 권한(run/read)이 이 요청을 허용하지 않습니다
429rate_limited가능이 키 또는 조직의 요청이 너무 많습니다, retryafters만큼 기다리세요
500internal_error가능예상하지 못한 오류입니다, 다시 시도하고 반복되면 request_id와 함께 알려 주세요

오류 봉투 모양과 전체 코드 표는 오류 코드에 있습니다

예시

curl "https://xenoci.com/api/runner/v1/balance" \
  -H "Authorization: Bearer $XENOCI_API_KEY"

다음 단계