Check Balance

    Query the balance status for the user that owns the current API Key.

    GET/api/v1/credits/balance
    FieldValue
    Base URLhttps://api.gate.ai
    AuthAuthorization: Bearer <API_KEY>
    FormatGate.AI REST JSON

    Request Parameters

    NameInTypeRequiredDescription
    AuthorizationheaderstringYesAPI Key authentication. Format: Bearer <API_KEY>

    Response Fields

    NameTypeDescription
    codeintegerBusiness status code. Success is always 200.
    dataobjectBalance data.
    data.statusintegerBalance status: 1 tradable, 2 insufficient balance, 4 overdue debt.
    data.messagestringStatus description.
    data.asset_typestringAsset ownership type: user_asset for personal assets, organization_asset for organization assets.
    data.recharge_balancestringRecharge balance.
    data.debt_amountstringDebt amount. Empty string or a zero-value string when there is no debt.

    Response Example

    json
    1{2  "code": 200,3  "data": {4    "status": 1,5    "message": "可以交易",6    "asset_type": "user_asset",7    "recharge_balance": "12.34000000",8    "debt_amount": ""9  }10}

    Response

    StatusMeaningDescriptionSchema
    200OKQuery succeeded. Returns code and data.CreditsBalanceResponse
    401UnauthorizedAPI Key is missing, invalid, expired, revoked, disabled, or inactive.ErrorResponse
    403ForbiddenThe member that owns the current API Key does not have permission to view the balance.ErrorResponse
    429Too Many RequestsRate limit reached.ErrorResponse
    500Internal Server ErrorGateway internal error, such as API Key lookup failure or response serialization failure.ErrorResponse
    502Bad GatewayBalance upstream service is unavailable, returned a non-success status, response parsing failed, or data is empty.ErrorResponse

    Error Response Example

    json
    1{2  "error": {3    "type": "authentication_error",4    "code": "7022002001",5    "message": "invalid api key"6  }7}