- 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 active single and bulk generation requests
get
/text/Generate/Bulk
This method retrieves all active single and bulk generation requests, including both pending and running requests. The response includes details such as request ID, user information, status, start and end times, and the number of completed and total records.
Requirements
Authentication Required
Bearer access_token
Request Headers
Authorization: Bearer access_token
Content-Type: application/json
Content-Type: application/json
Response
200
401
500
//This status is returned when the active generation requests are successfully retrieved.
//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 |
---|---|---|
id | string | The unique identifier for the generation request. |
userName | string | The username of the person who initiated the generation request. |
name | string | The name of the person who initiated the generation request. |
recordType | string | The type of the records in the queue (e.g. "Product"). |
storeId | string | The store ID associated with the records in the queue. |
status | string | The current status of the queue (e.g., "Pending", "Running"). |
startTime | string, date-time | The timestamp when the generation request was started. |
endTime | string, date-time | The timestamp when the generation request was completed (if applicable). |
estimatedEndTime | string, date-time | The estimated time of completion for the generation request. |
queuedIds | array of strings | A list of record IDs that are queued for processing. |
runningIds | array of strings | A list of record IDs that are ongoing processing. |
completedIds | array of strings | A list of record IDs that have been processed, whether successful or failed. |
failedIds | array of strings | A list of record IDs that have failed processing. |
completed | integer | The number of records that have been completed. |
total | integer | The total number of records to be processed. |
language | string | The language code associated with the generation request. |