Skip to main content
POST
https://api.keywordsai.co
/
api
/
v1
/
batches
/
{batch_id}
/
cancel
import requests
import json

batch_id = "batch_abc123"
url = f"https://api.keywordsai.co/api/v1/batches/{batch_id}/cancel/"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "X-Data-Keywordsai-Params": json.dumps({
        "customer_identifier": "user123"
    })
}

response = requests.post(url, headers=headers)
print(response.json())

{
  "id": "batch_abc123",
  "object": "batch",
  "endpoint": "/v1/chat/completions",
  "errors": null,
  "input_file_id": "file-abc123",
  "completion_window": "24h",
  "status": "cancelling",
  "output_file_id": null,
  "error_file_id": null,
  "created_at": 1711471533,
  "in_progress_at": 1711471538,
  "expires_at": 1711557933,
  "finalizing_at": null,
  "completed_at": null,
  "failed_at": null,
  "expired_at": null,
  "cancelling_at": 1711475163,
  "cancelled_at": null,
  "request_counts": {
    "total": 100,
    "completed": 23,
    "failed": 1
  },
  "metadata": {}
}
Cancel a batch job that is currently in progress. Cancellation is not immediate - the batch status will transition from cancelling to cancelled once the operation completes.
Important: Cancellation cannot be undone. Completed requests in the batch will still be billed, and you won’t get results for incomplete requests.
Customer credentials required: This endpoint requires your own OpenAI API key configured in Keywords AI dashboard (Settings → Providers).

​
Keywords AI parameters

You can pass Keywords AI tracking parameters via the X-Data-Keywordsai-Params header: 
-H "X-Data-Keywordsai-Params: {\"customer_identifier\": \"user123\"}"

​
Path parameters

​
batch_id
string
required
The unique identifier of the batch to cancel. Format: batch_xxxxx
batch_abc123

​
Response

Returns the batch object with cancelling status. Poll the retrieve batch endpoint to check when cancellation completes. 
{
  "id": "batch_abc123",
  "object": "batch",
  "endpoint": "/v1/chat/completions",
  "errors": null,
  "input_file_id": "file-abc123",
  "completion_window": "24h",
  "status": "cancelling",
  "output_file_id": null,
  "error_file_id": null,
  "created_at": 1711471533,
  "in_progress_at": 1711471538,
  "expires_at": 1711557933,
  "finalizing_at": null,
  "completed_at": null,
  "failed_at": null,
  "expired_at": null,
  "cancelling_at": 1711475163,
  "cancelled_at": null,
  "request_counts": {
    "total": 100,
    "completed": 23,
    "failed": 1
  },
  "metadata": {}
}

import requests
import json

batch_id = "batch_abc123"
url = f"https://api.keywordsai.co/api/v1/batches/{batch_id}/cancel/"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "X-Data-Keywordsai-Params": json.dumps({
        "customer_identifier": "user123"
    })
}

response = requests.post(url, headers=headers)
print(response.json())