- Getting started
- CREDIT ENDPOINTS
- GENERATE ENDPOINTS
- GETText generation rules and limits
- GETAvailable text generation tones
- GETText generation styles
- GETTarget audiences for text generation
- GETAvailable text types for generation
- GETText generation history
- GETStatus of generated texts
- GETGenerated text for multiple records
- GETActive generation requests
- GETDetails of a specific generation request
- POSTText generation
- POSTCancel a bulk generation request
- POSTUpdate generated text fields
- IMAGE ENDPOINTS
- KEYWORDS ENDPOINTS
- GETKeyword optimization data
- POSTOptimize keywords for text
- DELETEKeyword optimization
- PUTKeyword optimization
- GETKeyword optimization list
- PUTKeyword optimization data
- DELETERanking keywords
- PUTKeyword optimization pipelines
- GETKeyword state
- POSTKeyword pipeline
- DELETEKeyword pipeline
- POSTRestore keyword pipeline
- POSTAdd triggers to keyword pipeline
- POSTAdd triggers to a specific keyword pipeline
- POSTLock a specific keyword pipeline
- POSTUnlock a specific keyword pipeline
- GETPipeline snapshots
- PUTUpdate or create a snapshot
- POSTAdd manual keywords
- GETManual keywords
- REVIEW ENDPOINTS
- SUGGESTION ENDPOINTS
Get credit availability for operation
get
/text/Credit/isAvailable/{creditsToConsume}
This method checks whether the user has enough credits available to perform an operation that requires a specific number of credits. This is useful for confirming that a request can be made without running into credit limitations.
Requirements
Authentication Required
Bearer access_token
Request Headers
Authorization: Bearer access_token
| Parameter Name | Type | Description |
|---|---|---|
| creditsToConsume | required, number | The number of credits required for the operation you wish to check. This value must be a number in double format. |
Response
200
400
401
500
//This status is returned if there is an issue with the provided creditsToConsume value.
//This status is returned if the API key is missing or invalid.
//The server encountered an error when processing the request.
| Parameter Name | Type | Description |
|---|---|---|
| isAvailable | boolean | Indicates whether the user has enough credits to perform the operation (true if enough credits, false if not). |