Hanzo
OpenapiVisor

Cancels a queued or running render in the caller's org.

Cancels a queued or running render in the caller's org.

POST /v1/visor/fleet/jobs/{id}/cancel

Addresshttps://api.hanzo.ai/v1/visor/fleet/jobs/{id}/cancel
MethodPOST
OperationcancelFleetJob
AuthAuthorization: Bearer $HANZO_API_KEY

Cancels a queued or running render in the caller's org. The engine cancel is org-scoped, so a tenant can only ever cancel its OWN job: a job in another tenant's shard is 404, exactly like one that never existed. An already-finished job is 409.

Request

4 fields, body application/json (required).

FieldInTypeRequiredDescription
idpathstringyesID is the job (activity) id, from the URL path.
idbodystringID is the job (activity) id, from the URL path.
reasonbodystringReason is recorded on the cancellation; empty records "canceled from console".
runbodystringRun is the run id; empty defaults to the job id, which is what the dispatcher sets (runId == activityId == prompt_id), so the common case sends no body.

Response

StatusBodyMeaning
200jobCanceledok

200 body — 2 fields.

FieldInTypeAlwaysDescription
canceledbodystringCanceled is the job id that was canceled.
runbodystringRun is the run id the cancel was applied to.

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.


Visor API · All Hanzo APIs · Interactive reference

How is this guide?

On this page