Skip to main content
POST
/
v0.1
/
batches
/
{id}
/
cancel
Cancel Batch
curl --request POST \
  --url https://api.promptloop.com/v0.1/batches/{id}/cancel \
  --header 'x-api-key: <api-key>'
{
  "status": "success",
  "data": {
    "batch_id": "a427201b-2340-4f06-ad68-2da8e0fdb120",
    "cancelled": true,
    "jobs_removed": 5
  },
  "message": "<string>",
  "error": {
    "code": 123,
    "details": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.promptloop.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

Batch ID to cancel

Response

Batch successfully cancelled

​
status
enum<string>
required
Available options:
success,
error
Example:

"success"

​
data
object
required
​
message
string
required
​
error
object