Renders
Operations of the Document Render API. Paths are relative to your deployment's API host.
POST /api/document-render-api/renders
Render a source to PDF
Synchronous in v1: POST blocks until the render completes. Returns the record with status=READY and downloadUrl populated.
Authentication: bearer token (Authorization: Bearer <token>)
Request body: application/json RenderRequestDtoClass
| Status | Description | Body |
|---|---|---|
| 201 | application/json RenderRecordResponseDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
GET /api/document-render-api/renders/{id}
Get a render record
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes |
| Status | Description | Body |
|---|---|---|
| 200 | application/json RenderRecordResponseDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
GET /api/document-render-api/renders/{id}/download
Download the rendered file
Streams the rendered file bytes. 404 if the record is not READY (callers should poll GET /renders/:id first).
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes |
| Status | Description | Body |
|---|---|---|
| 200 | The rendered file bytes, in the format the render requested. | application/pdf string (binary), application/vnd.openxmlformats-officedocument.wordprocessingml.document string (binary) |