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

StatusDescriptionBody
201application/json RenderRecordResponseDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

GET /api/document-render-api/renders/{id}

Get a render record

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
idpathstringyes
StatusDescriptionBody
200application/json RenderRecordResponseDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/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>)

ParameterInTypeRequiredDescription
idpathstringyes
StatusDescriptionBody
200The rendered file bytes, in the format the render requested.application/pdf string (binary), application/vnd.openxmlformats-officedocument.wordprocessingml.document string (binary)