POST/api/v1/jobs/{job_id}/cancel
Cancel Job
Cancel a queued or processing job.
Cancellation Rules:
- Only queued or processing jobs can be cancelled
- Completed, failed, or already cancelled jobs cannot be cancelled
- Celery task is revoked (terminated) if currently executing
Use Cases:
- User-initiated cancellation
- Timeout or resource constraints
- Superseded by newer job submission
Request example
jsonjson
{
"tasks": [
{
"id": "T1",
"duration_days": 5
}
]
}Response example
jsonjson
{
"job_id": "550e8400-e29b-41d4-a716-446655440000",
"cancelled": true,
"message": "Job successfully cancelled"
}Schema
json-schema
{
"type": "object",
"additionalProperties": true,
"title": "Response Cancel Async Job Api V1 Jobs Job Id Cancel Post"
}Authentication
- x-api-key header
Reference details
- Operation ID
- cancel_async_job_api_v1_jobs__job_id__cancel_post
- Section
- Jobs
- Tags
- Jobs
Was this page helpful?
Your feedback helps us improve docs, reference pages, and Playground flows.
Topic: Cancel Job · Page: /docs/api-reference/cancel_async_job_api_v1_jobs__job_id__cancel_post