> ## Documentation Index
> Fetch the complete documentation index at: https://ailabtools.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Querying Credits
> Query API credit balances, purchased credits, warning thresholds, and update times for each API identifier.
export const QueryingCreditsTableRow = ({rowSpan = 0, category = "", href = "", apiName = "", sign = ""}) => {
const normalizedRowSpan = Number(rowSpan) || 0;
return
{normalizedRowSpan > 0 && |
{category}
| }
{href ? {apiName} : apiName}
|
{sign} |
;
};
## Unique Identification
| Name |
Unique Identification |
| Category |
Name |
Unique Identification |
| Category |
Name |
Unique Identification |
| Category |
Name |
Unique Identification |
## OpenAPI
````yaml GET /api/common/query-credits
openapi: 3.0.0
info:
title: AILabAPI
description: >-
[AILabTools](https://www.ailabtools.com) is an advanced tool that
offers a vast array of simple and flexible API endpoints to suit your
specific needs. With just one [API
KEY](https://www.ailabtools.com/doc/get-api-key), you can easily call
any of the endpoints and integrate them quickly into your application or
workflow, allowing for smooth and efficient operations.
[AILabTools](https://www.ailabtools.com) is continuously evolving,
and you can anticipate even more API endpoints being added in the future,
further enhancing its capabilities and usefulness for your artificial
intelligence and machine learning requirements.
version: 1.0.0
servers:
- url: https://www.ailabapi.com
description: Production server
security:
- apiKeyAuth: []
tags:
- name: AI IMAGE
- name: AI IMAGE > Image Enhancement
- name: AI IMAGE > Image Effects
- name: AI IMAGE > Image Editing
- name: AI IMAGE > Image Scoring
- name: AI BACKGROUND REMOVAL
- name: AI BACKGROUND REMOVAL > Portrait
- name: AI BACKGROUND REMOVAL > General
- name: AI PORTRAIT
- name: AI PORTRAIT > Portrait Effects
- name: AI PORTRAIT > Portrait Enhance
- name: AI PORTRAIT > Portrait Editing
- name: AI PORTRAIT > Portrait Analysis
- name: AI COMMON
paths:
/api/common/query-credits:
get:
tags:
- AI COMMON
summary: Querying Credits
description: >-
Query API credit balances, purchased credits, warning thresholds, and
update times for each API identifier.
responses:
'200':
headers:
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PublicResponseFields'
- type: object
required:
- data
properties:
data:
type: array
description: Credit entries grouped by API.
items:
type: object
required:
- unique_sign
- name
- balance
- total
- last_recharge_balance
- balance_warning
- first_buy_time
- last_update_time
properties:
unique_sign:
type: string
description: >-
Unique Identification. See [Unique
Identification](/docs/ai-common/querying-credits/api#api-identifier).
name:
type: string
description: Name.
balance:
type: number
format: float
description: Current credit balance.
total:
type: number
format: float
description: Total purchased credits.
last_recharge_balance:
type: number
format: float
description: Credit balance after the last recharge.
balance_warning:
type: number
format: float
description: Low-balance alert threshold.
first_buy_time:
type: integer
format: int64
description: Unix timestamp of the first purchase.
last_update_time:
type: integer
format: int64
description: Unix timestamp of the last balance update.
example:
request_id: ''
log_id: ''
error_detail:
code: ''
code_message: ''
message: ''
data:
- unique_sign: ''
name: ''
balance: 0
total: 0
last_recharge_balance: 0
balance_warning: 0
first_buy_time: 0
last_update_time: 0
description: Success
components:
schemas:
PublicResponseFields:
type: object
required:
- request_id
- log_id
- error_detail
properties:
request_id:
type: string
description: Request ID for debugging.
log_id:
type: string
description: Log ID for debugging.
error_detail:
$ref: '#/components/schemas/ErrorDetail'
ErrorDetail:
type: object
required:
- code
- code_message
- message
properties:
code:
type: string
description: >-
Error Code. See [Error
Codes](/docs/response-description#error-codes).
code_message:
type: string
description: Error summary.
message:
type: string
description: Detailed error message.
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: ailabapi-api-key
description: API Key for authentication
````