job_cancel
ManagementCancel Job
Cancel a queued or running Scenario job.
Args:
- job_id: required
- team_id, project_id: required for OAuth callers
Returns: the cancellation response.
Example: "Cancel this job" -> job_id="job_xxx"
open-world
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| job_id | string | ✓ | Job ID to cancel. |
| team_id | string | — | Team ID. Required if user belongs to multiple teams. |
| project_id | string | — | Project ID to scope the operation to. |
| response_format | enum(json | markdown) | json | Output format: 'json' for structured data, 'markdown' for human-readable text. |
Example Request
JSON
{
"job_id": "job_gen_123",
"team_id": "team_abc123",
"project_id": "proj_xyz789"
}Example Response
JSON
{
"job": {
"jobId": "job_gen_123",
"status": "canceled"
}
}Common Use Cases
- Cancel a generation job that is no longer needed