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
| Name | Type | Required | Description |
|---|---|---|---|
id | integer | Yes | The numeric ID of the render job. |
Responses
200 Render job status and artifact references
Content type application/json, object · OfficeRenderJobV1.
| Field | Type | Required | Description |
|---|---|---|---|
id | integer | No | Auto-incremented primary key. |
template_id | integer | No | ID of the template used for this render job. |
status | string | No | Current lifecycle status of the render job. One of: |
output_formats | array of string | No | List of output formats requested for this job. |
reference_id | string, nullable | No | Optional external reference identifier (e.g. "invoice:42") for linking the job to a source record. |
reference_type | string, nullable | No | The type of the referenced record (e.g. "invoice", "contract"). |
artifacts | array of object, nullable | No | Output artifacts produced by a completed job. Null while still queued or processing. |
artifacts[].format | string | No | The output format of this artifact. |
artifacts[].document_id | integer | No | ID of the document artifact (use for /documents/{id}/download). |
artifacts[].size_bytes | integer | No | File size of the artifact in bytes. |
error_message | string, nullable | No | Human-readable error reason when status is "failed". |
queued_at | string (date-time) | No | |
completed_at | string (date-time), nullable | No |
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"