Cancel Job
curl --request POST \
--url https://api.vachana.ai/stt/v3/batch/jobs/{job_id}/cancel \
--header 'Content-Type: application/json' \
--header 'X-API-Key-ID: <api-key>' \
--data '
{
"reason": "Docs verification cancel test"
}
'import requests
url = "https://api.vachana.ai/stt/v3/batch/jobs/{job_id}/cancel"
payload = { "reason": "Docs verification cancel test" }
headers = {
"X-API-Key-ID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key-ID': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({reason: 'Docs verification cancel test'})
};
fetch('https://api.vachana.ai/stt/v3/batch/jobs/{job_id}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"job_id": "019fa79c-7880-7d05-a528-edc7892ad9ea",
"status": "CANCELLED",
"message": "Job cancelled successfully.",
"cancelled_at": "2026-07-28T07:24:38.366982Z"
}Cancel Job
Cancel a batch transcription job.
POST
/
stt
/
v3
/
batch
/
jobs
/
{job_id}
/
cancel
Cancel Job
curl --request POST \
--url https://api.vachana.ai/stt/v3/batch/jobs/{job_id}/cancel \
--header 'Content-Type: application/json' \
--header 'X-API-Key-ID: <api-key>' \
--data '
{
"reason": "Docs verification cancel test"
}
'import requests
url = "https://api.vachana.ai/stt/v3/batch/jobs/{job_id}/cancel"
payload = { "reason": "Docs verification cancel test" }
headers = {
"X-API-Key-ID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key-ID': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({reason: 'Docs verification cancel test'})
};
fetch('https://api.vachana.ai/stt/v3/batch/jobs/{job_id}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"job_id": "019fa79c-7880-7d05-a528-edc7892ad9ea",
"status": "CANCELLED",
"message": "Job cancelled successfully.",
"cancelled_at": "2026-07-28T07:24:38.366982Z"
}Overview
Cancel a batch job that is not already in a conflicting terminal state.| Current status | Result |
|---|---|
CREATED | Immediately CANCELLED (200) |
STARTING / QUEUED / IN_PROGRESS | CANCELLING → CANCELLED |
Already CANCELLED | 409 JOB_CANCELLED |
| Other terminal states | Conflict error |
Authentication
| Header | Required | Description |
|---|---|---|
X-API-Key-ID | Yes | Your Gnani Prisma v2.5 API key |
Path Parameters
string
required
Job ID returned by Create Job.
Request Body
string
Optional cancel reason.
Example cURL
curl -X POST "https://api.vachana.ai/stt/v3/batch/jobs/019fa262-971e-766b-95f0-ea57d8e0626d/cancel" \
-H "X-API-Key-ID: <YOUR_API_KEY>" \
-H "Content-Type: application/json" \
--data-raw '{"reason":"No longer needed"}'
Response
Success (200)
{
"job_id": "019fa262-971e-766b-95f0-ea57d8e0626d",
"status": "CANCELLED",
"message": "Job cancelled successfully.",
"cancelled_at": "2026-07-27T07:03:18.827605Z"
}
Error responses
409 Already cancelled{
"error": "JOB_CANCELLED",
"message": "Job is already cancelled"
}
Use Cases
- Cancelling a job before start when files were uploaded by mistake
- Stopping an in-progress batch when the pipeline is aborted
Authorizations
Your Gnani API key
Path Parameters
Job ID returned by Create Job. Paste the UUID from the Create Job response.
Body
application/json
Optional cancel reason
Example:
"Docs verification cancel test"
Response
Cancelled
The response is of type object.
Was this page helpful?