Sign in

v4

latestOpenAPI 3.1.02026-08-01207318738.7 KB
AI

Cancel an AI job

Request cancellation of an AI job. This endpoint is idempotent — calling it on an already-cancelled or completed job returns success with the current state. For QUEUED jobs, cancellation is immediate. For EXECUTING jobs, the worker will stop after completing its current iteration. Jobs in DELIVERING state cannot be cancelled as they are already finalizing results. Only the job owner or organization admins can cancel jobs.

post/api/v1/ai/jobs/{jobId}/cancel

Path parameters

jobIdstring uuid required

The unique identifier of the AI job

Example:123e4567-e89b-12d3-a456-426614174000

The unique identifier of the AI job

Response

Cancellation request processed. The state field indicates the job's state after the attempt — CANCELLED if successful, or the current terminal state if the job had already completed.

jobIdstring uuid required

The job ID that was requested to cancel.

state'CANCELLED' | 'COMPLETE' | 'DELIVERING' | 'EXECUTING' | 'FAILED' | 'QUEUED' required

The job state after the cancellation attempt. CANCELLED if the cancellation was successful. If the job was already in a terminal state (COMPLETE, FAILED, CANCELLED), the current state is returned unchanged — the endpoint is idempotent.

Example response

{
  "jobId": "550e8400-e29b-41d4-a716-446655440000",
  "state": "CANCELLED"
}