Skip to main content
Use this endpoint to retrieve a fully rendered HTML report for a completed cognitive roadmap. The response contains the complete HTML document inside the standard JSON envelope, making it easy to embed directly in your portal, print, or convert to PDF.

​
Prerequisites

The roadmap must be finished (is_finished: true). If the roadmap is not yet complete, the endpoint returns a 409 error. Confirm completion by polling /roadmap/{token}/generate/status/ first.

​
Endpoint

​
Path Parameters

​
string
required
The unique cognitive roadmap instance UUID.

​
Response

​
string
The fully rendered HTML report as a string. Wrap this content in an iframe or render it directly in your application.

​
Example Request

​
Example Response

​
Use Cases

Portal Embedding

Inject the HTML into an iframe or render it directly inside your participant dashboard for immediate viewing.

Print & PDF

Use browser print-to-PDF or a headless rendering tool to generate a downloadable PDF report from the HTML content.

​
Error Responses