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

delete

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.

Authorizations

apiKeyAuth

X-API-KeystringRequired

Authentication via the Topaz generated key in the X-API-Key header.

Path parameters

process_idstring · uuidRequired

The UUID of the image processing job.

Responses

204

The image processing job was successfully cancelled. No content returned.

400

The request contains malformed data in the body, path, or query parameters.

application/json

401

Authentication is required and has failed or has not yet been provided.

application/json

403

The API key doesn't have permissions to perform the request.

application/json

404

The requested resource does not exist.

application/json

409

The request conflicts with the current state.

application/json

429

Too many requests hit the API too quickly. A backoff (e.g. exponential) is recommended for your requests.

application/json

500

Unexpected error on our end.

application/json

delete

/cancel/{process_id}

HTTPcURLJavaScriptPython

DELETE /image/v1/cancel/{process_id} HTTP/1.1
Host: api.topazlabs.com
X-API-Key: YOUR_API_KEY
Accept: */*

No content