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

잔액 조회

GET/v1/balance

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

API 키 권한 read 또는 콘솔 세션으로 부릅니다, 콘솔 세션은 조직 역할 owner, admin, developer만 됩니다

  • API 키는 자기 조직을 읽습니다, 콘솔 세션은 org_id를 보냅니다

Headers

  • Authorization: optional string
    Bearer xci_live_… 워크스페이스 API 키, 키 권한 read(run 키도 가능), 콘솔 세션 쿠키로 대신할 수 있습니다

Query Parameters

  • org_id: optional string
    콘솔 세션은 필수, API 키는 무시(키의 조직)

Returns

200 application/json

  • Balance: object
    • organization_id: string
      조직 ID
    • balance_micro_usd: integer
      원장 합계 잔액(µUSD)
      최소 0
    • balance_usd: string
      같은 금액의 USD 문자열(센트, 소수 2자리)
      형식 ^-?[0-9]+\.[0-9]{2}$
    • available_micro_usd: integer
      만료되지 않은 로트 합에서 실행 중인 잡이 이미 쓴 금액을 뺀 값
      최소 0
    • available_usd: string
      같은 금액의 USD 문자열(센트, 소수 2자리)
      형식 ^-?[0-9]+\.[0-9]{2}$
    • reserved_micro_usd: integer
      실행 중인 잡이 이미 쓴 금액
      최소 0
    • reserved_usd: string
      같은 금액의 USD 문자열(센트, 소수 2자리)
      형식 ^-?[0-9]+\.[0-9]{2}$
    • rate_micro_usd_per_min: integer
      지금 적용되는 분당 요율(µUSD)
    • low: boolean
      사용 가능 잔액이 낮은 잔액 기준 아래인지
    • low_threshold_micro_usd: optional integer
      낮은 잔액 기준
      최소 0
    • low_threshold_usd: optional string
      낮은 잔액 기준(USD)
      형식 ^-?[0-9]+\.[0-9]{2}$
    • next_expiry: optional object { expires_at, remaining_micro_usd, remaining_usd } or null
      다음에 만료될 로트의 시각과 남은 금액, 없으면 null
      • expires_at: optional string
        만료 시각
        RFC 3339 UTC 시각
      • remaining_micro_usd: optional integer
        금액(µUSD 정수)
        최소 0
      • remaining_usd: optional string
        같은 금액의 USD 문자열(센트, 소수 2자리)
        형식 ^-?[0-9]+\.[0-9]{2}$
    • topup_url: string
      콘솔 충전 페이지, 결제 토큰은 없고 로그인이 필요합니다

오류

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

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

다음 단계