Retrieve a document render as base64 (product modules)

Retrieve the PDF of a completed render as base64-encoded JSON, for product module code that passes the file on to another service, for example as an email attachment.

For product module code only. Call it from product module code with the token the code runs with, or from the Root dashboard. API keys are rejected, so this endpoint cannot be tried from this page.

Only complete renders have a file; any other status returns 404.

Documents are opt-in per organization: unless the org_documents feature flag is enabled for your organization this endpoint returns 404.

Path Params
string
required

Must be a UUID. The unique identifier of the render.

Responses

403

The request was made with an API key, or the caller is missing the communications:read permission.

404

No such render, a policy render whose policy is outside the caller's user group, any other render when the caller is restricted to a user group, the render has no file (it is not complete), or documents are not enabled for the organization.

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json