Cancel
If an image processing job is no longer needed or was started in error, you can cancel it before it completes. The job must be in a cancellable state (e.g., not already completed or failed) for the request to be successful.
Cancel a pending image processing job. If the job has already completed, or if it is not in a cancellable state, this request will fail with a conflict error. Use this to prevent unnecessary costs for jobs started in error.
Authentication via the Topaz generated key in the X-API-Key header.
The UUID of the image processing job.
The image processing job was successfully cancelled. No content returned.
The request contains malformed data in the body, path, or query parameters.
Authentication is required and has failed or has not yet been provided.
The API key doesn't have permissions to perform the request.
The requested resource does not exist.
The request conflicts with the current state.
Too many requests hit the API too quickly. A backoff (e.g. exponential) is recommended for your requests.
Unexpected error on our end.
DELETE /image/v1/cancel/{process_id} HTTP/1.1
Host: api.topazlabs.com
X-API-Key: YOUR_API_KEY
Accept: */*
No content
Last updated