Skip to content

Re-enqueue this asset's preview job

POST
/assets/{id}/preview

Inserts a fresh job of the preview kind that matches the asset’s file extension (preview.raster / preview.video / preview.3d / preview.audio / preview.pdf / preview.font / preview.ebook / preview.eps / preview.psd / preview.comic / preview.text) at PriorityHigh. The worker picks it up within a tick.

By default the job is enqueued with force=true, which re-renders variants that already exist. Without it this endpoint could not do the thing it is named for: every handler skips outputs already present in storage, so the job completed successfully having written nothing and the thumbnail never changed.

Each rung is overwritten in place by an atomic backend write — nothing is deleted first, so an interrupted re-render leaves the previous preview intact rather than an asset with none.

Useful after attaching new companions (so a 3D model can re-render with its textures) or after a worker bug-fix landed and the user wants the existing rendered output regenerated against the new code.

Returns the freshly-enqueued job id so callers can poll /jobs/{id}/status if they want a progress UI.

id
required
string format: uuid
force

true (the default) re-renders every output, ignoring what is already in storage. false is the cheap gap-filling pass: outputs already present are left alone, which is what makes a re-queue of an up-to-date asset nearly free.

boolean
default: true

Job enqueued

object
job_id
required
string format: uuid
job_type
required
string
force
required

Whether the enqueued job will re-render existing variants. Echoed back so a caller can tell a real re-render from a gap-filling pass without decoding the job payload.

boolean

Malformed request

object
error
required

Human-readable error summary

string
Example
the request could not be completed

Authentication required, missing, or invalid

object
error
required

Human-readable error summary

string
Example
the request could not be completed
Example
{
"error": "authentication required: sign in and retry with a valid session or API token"
}

Resource not found

object
error
required

Human-readable error summary

string
Example
the request could not be completed

Unexpected server error

object
error
required

Human-readable error summary

string
Example
the request could not be completed