Skip to content

Get render job status

GET/office/render-jobs/{id}

Retrieves the current status and result metadata for a queued or completed render job. Poll until status is "completed" or "failed". On completion, artifact download URLs are included in the response for each output format.

Request

Path parameters

NameTypeRequiredDescription
idintegerYes

The numeric ID of the render job.

Responses

200 Render job status and artifact references

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

Example

{
  "id": 88,
  "template_id": 3,
  "status": "completed",
  "output_formats": [
    "pdf"
  ],
  "artifacts": [
    {
      "format": "pdf",
      "document_id": 201,
      "size_bytes": 84320
    }
  ],
  "reference_id": "invoice:42",
  "queued_at": "2026-04-08T12:00:00Z",
  "completed_at": "2026-04-08T12:00:08Z"
}

404 Render job not found

Example request

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