Skip to content

Retry failed render job

POST/office/render-jobs/{id}/retry

Re-queues a failed render job for reprocessing. Use when a render failed due to a transient worker error or temporary unavailability of an external dependency. The previous failure reason is preserved in the job's attempt log.

Request

Path parameters

NameTypeRequiredDescription
idintegerYes

The numeric ID of the failed render job to retry.

Responses

202 Job re-queued for reprocessing

Content type application/json, object · OfficeRenderJobV1.

FieldTypeRequiredDescription
idintegerNo

Auto-incremented primary key.

template_idintegerNo

ID of the template used for this render job.

statusstringNo

Current lifecycle status of the render job.

One of: "queued", "processing", "completed", "failed"

output_formatsarray of stringNo

List of output formats requested for this job.

reference_idstring, nullableNo

Optional external reference identifier (e.g. "invoice:42") for linking the job to a source record.

reference_typestring, nullableNo

The type of the referenced record (e.g. "invoice", "contract").

artifactsarray of object, nullableNo

Output artifacts produced by a completed job. Null while still queued or processing.

artifacts[].formatstringNo

The output format of this artifact.

artifacts[].document_idintegerNo

ID of the document artifact (use for /documents/{id}/download).

artifacts[].size_bytesintegerNo

File size of the artifact in bytes.

error_messagestring, nullableNo

Human-readable error reason when status is "failed".

queued_atstring (date-time)No
completed_atstring (date-time), nullableNo

404 Render job not found

409 Job is not in "failed" status and cannot be retried

Example request

curl -X POST "https://{tenant}.faciotech.net/api/v1/office/render-jobs/{id}/retry" \
  -H "Accept: application/json"
Loading