- 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
Cancel a generation request
post
/text/Generate/Bulk/{id}/cancel
This method cancels an active generation request by its unique ID. Once executed, the generation process will be in a cancelling state, and will try to finish any generation on currently precessing records. Any records still in the queue will no longer be processed for this particular ID.
Requirements
Authentication Required
Bearer access_token
Request Headers
Authorization: Bearer access_token
| Parameter Name | Type | Description |
|---|---|---|
| id | string, required | The unique identifier for the bulk generation request that you want to cancel. |
Example API Request
Response
200
404
500
//This status is returned when the bulk generation request is successfully canceled.
//This status is returned if the specified bulk request ID does not exist.
//The server encountered an error when processing the request.