Cancel job

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"
}

POST

stt

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

Part of Batch transcription, which covers the whole flow, models, languages and limits. 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 API key

Path parameters

In Try it, paste a real job_id from Create job before clicking Send. Leaving the placeholder {job_id} in the URL returns 422.

string

default:"019fa854-1db0-7e45-a026-7a6b09ff6d7c"

required

Job ID returned by Create job. Replace with your own job_id before sending.

Request body

string

default:"Docs verification cancel test"

Optional cancel reason.

Example cURL

curl --request POST \
  --url https://api.vachana.ai/stt/v3/batch/jobs/019fa79c-7880-7d05-a528-edc7892ad9ea/cancel \
  --header 'X-API-Key-ID: <YOUR_API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{"reason":"Docs verification cancel test"}'

Example — Python SDK

from gnani.stt import GnaniSTTBatchClient

client = GnaniSTTBatchClient()

job = client.get_job("<job_id>")
job.cancel(reason="uploaded the wrong files")
print(job.status)                      # CANCELLING or CANCELLED

See the Python SDK.

Response

Success (`200`)

{
  "job_id": "019fa79c-7880-7d05-a528-edc7892ad9ea",
  "status": "CANCELLED",
  "message": "Job cancelled successfully.",
  "cancelled_at": "2026-07-28T07:24:38.366982Z"
}

Error responses

409 Already cancelled

{
  "error": "JOB_CANCELLED",
  "message": "Job is already cancelled"
}

404 Job not found

{
  "error": "JOB_NOT_FOUND",
  "message": "Job 01900000-0000-7000-8000-000000000000 not found"
}

409 Already finished

{
  "error": "JOB_ALREADY_COMPLETED",
  "message": "Job has already finished with status 'COMPLETED'"
}

string

CANCELLED on success.

string

Timestamp when the job was 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

X-API-Key-ID

string

header

required

Your Gnani API key

Path Parameters

job_id

string

default:019fa854-1db0-7e45-a026-7a6b09ff6d7c

required

Job ID returned by Create Job. Paste the UUID from the Create Job response.

Body

application/json

reason

string

Optional cancel reason

Example:

"Docs verification cancel test"

Response

Cancelled

The response is of type object.

Gnani APIs

APIs

Use Cases

Reference

Overview

Authentication

Path parameters

Request body

Example cURL

Example — Python SDK

Response

Success (`200`)

Error responses

Use cases

Authorizations

Path Parameters

Body

Response

​Overview

​Authentication

​Path parameters

​Request body

​Example cURL

​Example — Python SDK

​Response

​Success (200)

​Error responses

​Use cases

Authorizations

Path Parameters

Body

Response

Overview

Authentication

Path parameters

Request body

Example cURL

Example — Python SDK

Response

Success (`200`)

Error responses

Use cases