Get a document render
/document-renders/{id}Returns the job that POST /document-renders started, the same view as GET /jobs/{id} limited to renders. Once it has succeeded, result has format, filename, content_type, size_bytes, download_url and expires_at; the file is kept for 7 days, after which download_url is null. A failed render carries an error. A token sees only the renders it started: an unknown id, another token's render and any job that is not a render all return 404.
Path parameters
The record's id.
Query parameters
Comma-separated top-level fields to return.
idis always returned.
Responses
{
"data": {
"id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
"type": "string",
"status": "queued",
"progress": {
"done": 1,
"total": 1
},
"result": {},
"error": {},
"created_at": "2026-06-12T10:00:00+00:00",
"updated_at": "2026-06-12T10:00:00+00:00",
"completed_at": "2026-06-12T10:00:00+00:00"
}
}Authorization failed. error.code is one of org_disabled,
ip_blocked, missing_scope, scope_disabled, user_disabled.
The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per
problem, or a code documented on the operation.
Examples
curl https://your-org-domain/kong/core/api/v2/document-renders/{id}\
-H "Authorization: Bearer $HELM_API_KEY"\
-H "Content-Type: application/json"