Get Usage of API Credits

Action GetApiPointUsage

Introduction

⚠️

This interface is no longer maintained.

This interface is used to query the usage of API credits of the current account.

Request

Parameter Name	Type	Description	Required
Action	`String`	The corresponding API command name, which is `GetApiPointUsage` for this API	✓
PublicKey	`String`	User's public key, which can be obtained from the User Center (opens in a new tab)	✓
Signature	`String`	User's signature generated based on the public key and API command, see Signature	✓
request_uuid	`String`	Request UUID, randomly generated using the UUID generation method

Request Example

{
    "Action":    "GetApiPointUsage",
    "PublicKey": "ALLak9M4cNdHXKOJAJJ4k8Hh1hZS2EgJF1D0FlPwfl",
    "request_uuid":"b91fcfbe-bb35-47ce-a168-bd6252c75270",
    "Signature": "0131f4e4296f3ca8e1220b47247e83a4315ea8e1"
}

Response

Field Name	Type	Description	Required
RetCode	`Int`	Return status code. 0 indicates a successful response, non-zero indicates a failure.	✓
Action	`String`	Operation command name.	✓
Message	`String`	Error message returned. Provides detailed description when `RetCode` is non-zero.
TotalPointNum	`Int`	Total number of account API points	✓
UsedPointNum	`Int`	Number of account API points used	✓
ExpireTime	`Int`	API Points Expiration Time

Response Example

{
	"Action": "GetApiPointUsage",
	"RetCode": 0,
	"Message": "",
	"TotalPointNum": 100000,
	"UsedPointNum": 100,
	"ExpireTime": 1725693991
}

InPaint