Batches
...
Batches API
Batches

Stop Batch

3min

Stop Batch

Batches can be stopped when they are in the queued or running state by making an HTTP GET request to the /batches/BATCH_ID/stop endpoint (where BATCH_ID is the id of the Batch).

When stopping a Batch that is currently queued you will be refunded for the credits allocated for that Batch run. If the Batch has already started running (i.e. it is in the state running ) then a credit refund will not be issued, but the Batch will still be stopped.



Example

GET /batches/BATCH_ID/stop

In the example below we stop a Batch with id=123456 :

HTTP
Curl
Node.js
Python
PHP


VALUE SERP responds with a JSON object confirming that the Batch has been stopped, or detailing the error if it has not been possible to stop the Batch (i.e. if the Batch is not curently queued or running ).



Next Steps      Get Batches      List Batches      Stop All Batches

Updated 13 Aug 2024
Did this page help you?