Render a template’s example

View as Markdown
Renders the template with one of its saved examples and returns the PDF bytes — the editor's preview button. `example` names the example to use; without it the first one is rendered. A template with no examples at all still previews — it renders with empty data `{}`, which is what a fresh template's static content needs. A template with no files or no `main` answers `422 config_incomplete`; a name that matches no saved example answers `404 example_not_found`. **Learn more:** [Compose](https://docs.cloudraker.com/capabilities/compose)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idOrSlugstringRequired>=1 character

Request

This endpoint expects an object.
examplestringOptional>=1 character

Response

The rendered PDF.

Errors

404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error