Render a document template for a case

Render a case_report document template for a case and get the PDF back in the response. The latest published version of the template is used. No request body is needed. Unlike POST /cases/{id}/generate-report, which queues the full case report and delivers it through the CaseReport.Generated webhook, this endpoint answers synchronously and renders the template configured in your workspace.

Rendering goes through a third party, so this endpoint can also answer CASE_REPORT_RENDER_FAILED: a 400 carrying the reason when the template itself cannot be rendered, or a 502 when the rendering service is unavailable. Retrying only helps the 502.


See also

Learn more about Cases

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Render a report for a case by its Dotfile internal id.

string
required

Key of the case_report document template to render, as configured in your workspace.

Responses

400

The request is either malformed or contain invalid parameters.

  • Make sure the identifier specified in the URL is a valid UUID
  • The document template has no published version yet (DOCUMENT_TEMPLATE_NOT_PUBLISHED)
  • The case has too many checks for a synchronous report (CASE_REPORT_TOO_MANY_CHECKS), use POST /cases/{id}/generate-report instead
  • The document template could not be rendered (CASE_REPORT_RENDER_FAILED)
404

No case or document template can be found.

502

The rendering service is unavailable (CASE_REPORT_RENDER_FAILED). Retry the request.

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