Skip to main content
PATCH
Cancel job

Authorizations

Authorization
string
header
required

Bearer token authentication using API tokens for team-based access control.

You can generate your own API token at: https://app.nexrender.com/settings/api-tokens

Path Parameters

id
string
required

Unique job identifier

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Response

Successfully cancelled the job and any related jobs that were also cancellable.

id
string

Unique job identifier used for tracking and API operations

templateId
string | null

Reference to the template used for this job (null if template was not used)

status
string

Current job status (queued, render:dorender, finished, error, etc.). Manually cancelled jobs are normalized to manually_cancelled in v2 responses even though they are stored internally as error.

progress
number<float>

Render progress as a percentage (0.0 to 100.0)

stats
object

Detailed timing and metadata statistics for the job

outputUrl
string | null

URL to the rendered content