OMomni
AI

Cancel AI job

Changed on

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 a DELIVERING state cannot be cancelled as they are already finalizing results. Only the job owner or organization admins can cancel jobs.
post/v1/ai/jobs/{jobId}/cancel

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/ai/jobs/{jobId}/cancel
  • Auth
    HTTP bearer

Path parameters

jobIdstring uuid required

The unique identifier of the AI job to cancel

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

The unique identifier for the cancelled job

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

The job's state after the cancellation attempt. CANCELLED if the cancellation succeeded. If the job was already in a terminal state (COMPLETE, FAILED, CANCELLED), the current state is returned unchanged.

Changes

  • 43290040f88fRevision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      added the new COMPLETE enum value to the response property for the response status

    • warning

      added the new DELIVERING enum value to the response property for the response status

    • warning

      added the new EXECUTING enum value to the response property for the response status

    • warning

      added the new FAILED enum value to the response property for the response status

    • warning

      added the new QUEUED enum value to the response property for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status