pydo.inference.cancel_batch()
Generated on 7 May 2026
from pydo version
v0.34.0
Description
Requests cancellation of a batch job. The job transitions to cancelling and, once in-flight requests drain, to cancelled. Jobs already in a terminal state (completed, failed, expired, cancelled) cannot be cancelled and return 409 Conflict.
Partial results produced before cancellation remain available via GET /v1/batches/{batch_id}/results.
Parameters
| Name | Type | Required | Description | Default Value |
|---|---|---|---|---|
batch_id |
string | True | The batch job identifier. |
More Information
See the API spec for this endpoint to view additional detail on responses, headers, parameters, and more.