Checking API usage and balance

Manage your Muzaic API usage and view your current monthly balance via the /accountDetails endpoint.

Using accountDetails endpoint

accountDetails

GET /accountDetails

Endpoint allows you to obtain JSON with tokens usage and account balance information.

200: OK

{
    "apiVersion": "1.2.0",
    "secretKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "freeTokensAvailable": 0,
    "totalUsedTokens": 2238247,
    "currentBalance": 248903
}

Response handling

When making a request to an endpoint, you can retrieve several pieces of information:

• apiVersion: Indicates the current version of the Muzaic API.

• secretKey: The user's secret key for authentication.

• freeTokensAvailable: Shows if there are free tokens available (greater than 0) for the account holder.

• totalUsedTokens: Provides information on the lifetime usage of tokens.

• currentBalance: Helps estimate the cost for the next billing cycle.

Example response

{
    "apiVersion": "1.2.0",
    "secretKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "freeTokensAvailable": 0,
    "totalUsedTokens": 2238247,
    "currentBalance": 248903
}

Important: Always include the 'Muzaic API Secret Key' in your request headers.