Browse documentation
API referenceDELETE/v1/batch/jobs/{job_id}Free

Cancel batch job

DELETE /v1/batch/jobs/{job_id}

Cancel a pending or in-progress batch job by id. Finished jobs cannot be cancelled and return an error instead.

When to use it

Use this endpoint for user-initiated cancellation in batch dashboards.

Authentication and billing

  • Requires X-API-Key or api_key.
  • Credit cost: Free. Non-billable batch control route.
  • See pricing for plan allowances and full billing details.

Request

This endpoint does not require a request body.

FieldLocationRequiredNotes
job_idpathYesBatch job id to cancel.
api_keyqueryNoOptional alternative to the X-API-Key header. Prefer the header for server-side applications.

Response

Returns the cancellation result or an error for finished jobs.

Successful Responseapplication/json
{
  "id": "batch_a1b2c3d4e5f6g7h8",
  "status": "cancelled"
}

Request pattern

bash
curl -X DELETE "https://developers.manasija.in/v1/batch/jobs/batch_a1b2c3d4e5f67890" \
  -H "X-API-Key: $DRISHTI_API_KEY"

JavaScript / TypeScript SDK

ts
await client.deleteBatchJobsJobId({ job_id: "batch_a1b2c3d4e5f67890" })

Python SDK

python
client.delete_batch_jobs_job_id(job_id="batch_a1b2c3d4e5f67890")

Interactive reference

Use the Scalar API client for executable requests, schemas, and the full OpenAPI contract.