Dynamic Graphics Render
Manage jobs

Cancel a render job

Changed on

Aborts an in-flight render job. Returns 202 Accepted as soon as the cancellation has been accepted; subsequent calls to GET /v1/status/{jobId} will report "status": "canceled" once the worker has fully stopped the underlying render.

Applicable only to render jobs submitted via POST /v1/templates/render. This endpoint does not apply to Describe, Reframe, TLS, TTS, or Avatar jobs.

Notes:

  • Cancellation is idempotent.
  • Once propagated to the worker, in-progress outputs are not uploaded to the destinations specified in the original render request.
  • For a short window after the PUT, the status endpoint may still report running; poll until it transitions to canceled.
put/v1/cancel/{jobId}

Request

  • Base URL: https://audio-video-api.adobe.io
  • URL: https://audio-video-api.adobe.io/v1/cancel/{jobId}
  • Auth: HTTP bearer and API key in header x-api-key

Path parameters

jobIdstring uuid required

UUID of the render job to cancel, as returned in the jobId field of the original 202 submit response or in the cancelUrl property of a List Render Jobs response item.

Headers

x-request-idstring uuid
Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

GUID, unique per request. Auto-generated if not provided.

Response

Cancellation accepted. The job is transitioning to canceled; poll GET /v1/status/{jobId} to observe the terminal state.

jobIdstring uuid required

UUID of the render job for which cancellation was accepted.

status'canceling' required

Transient in-progress status. Poll GET /v1/status/{jobId} to observe the terminal canceled state.

Changes