Render Task Results

Version 4.0.24.18

Get the document or image produced by a completed render task.

Note that the PDF or image result will be a binary blob in the HTTP response, as indicated by the Content-Type in the response headers. This may require specialized (or at least different) handling than text responses such as JSON. You may need to tell your HTTP client that the response is binary so that it does not attempt to parse the binary data as text.

If the render task exists but has not finished rendering the results, the response HTTP status will be 202 Accepted, the response body will be empty, and the response will have a Retry-After header indicating that the caller should repeat the request at a later time.

Returns 404 if the render task cannot be found, if the cached result has expired, or if the caller does not have permission to view the results.

For detailed information about the status of the render task, use Render Task. Polling loops waiting for completion of a render task would be better served by polling render_task(id) until the task status reaches completion (or error) instead of polling render_task_results(id) alone.

Request

GET /render_tasks/{render_task_id}/results
Datatype
Description
Request
HTTP Request
path
HTTP Path
Expand HTTP Path definition...
render_task_id
string
Id of render task

Response

200: Document or image

Datatype
Description
(string)
string

202: Accepted

400: Bad Request

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

404: Not Found

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

429: Too Many Requests

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

Examples