Render HTML to PDF
POST
/render/html
const url = 'http://localhost:8080/render/html';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"html":"example","baseUrl":"example","attachments":[{"name":"example","content":"example","mimeType":"example","description":"example","relationship":"example"}],"xmpSchemas":[{"namespace":"example","prefix":"example","name":"example","properties":[{"name":"example","value":"example","valueType":"example","category":"example","description":"example"}]}],"embedColorProfile":true}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url http://localhost:8080/render/html \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "html": "example", "baseUrl": "example", "attachments": [ { "name": "example", "content": "example", "mimeType": "example", "description": "example", "relationship": "example" } ], "xmpSchemas": [ { "namespace": "example", "prefix": "example", "name": "example", "properties": [ { "name": "example", "value": "example", "valueType": "example", "category": "example", "description": "example" } ] } ], "embedColorProfile": true }'Renders HTML to a PDF/A-3a + PDF/UA document, or a JSON validation response when Accept is application/json.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Header Parameters
Section titled “Header Parameters ” X-Upload-Url
string
Presigned PUT URL that receives the generated document.
Request Body required
Section titled “Request Body required ” Media type application/json
RenderHtmlRequest
object
html
required
string
baseUrl
string | null
attachments
Array<object> | null
FileAttachmentobject
name
required
string
content
required
string
mimeType
string
description
string | null
relationship
string
xmpSchemas
Array<object> | null
XmpSchemaobject
namespace
required
string
prefix
required
string
name
required
string
properties
required
Array<object>
XmpPropertyobject
name
required
string
value
required
string
valueType
string
category
string
description
string | null
embedColorProfile
boolean
Example generated
{ "html": "example", "baseUrl": "example", "attachments": [ { "name": "example", "content": "example", "mimeType": "example", "description": "example", "relationship": "example" } ], "xmpSchemas": [ { "namespace": "example", "prefix": "example", "name": "example", "properties": [ { "name": "example", "value": "example", "valueType": "example", "category": "example", "description": "example" } ] } ], "embedColorProfile": true}Responses
Section titled “ Responses ”PDF document or JSON validation response
string format: binary
RenderPdfResponse
object
validation
required
ValidationResponse
object
isCompliant
required
boolean
profiles
required
Array<object>
ProfileResultobject
profile
required
string
specification
required
string
isCompliant
required
boolean
totalChecks
required
integer
passedChecks
required
integer
failedChecks
required
integer
summary
required
ValidationSummary
object
totalChecks
required
integer
passedChecks
required
integer
failedChecks
required
integer
categories
Array<object>
CategoryResultobject
category
required
string
passedChecks
required
integer
failedChecks
required
integer
documentInfo
One of:
DocumentInfo
object
pages
required
integer
tagged
required
boolean
language
string | null
structureElements
required
integer
fonts
required
Array<object>
FontInfoobject
name
required
string
embedded
required
boolean
type
required
string
images
required
integer
null
failures
Array<object>
ValidationFailureobject
profile
required
string
clause
required
string
testNumber
required
integer
category
required
string
message
required
string
location
string | null
errorDetails
string | null
metadata
One of:
PdfMetadata
object
title
string | null
subject
string | null
author
string | null
creator
string | null
producer
string | null
creationDate
string | null
null
pdf
required
string
Example generated
{ "validation": { "isCompliant": true, "profiles": [ { "profile": "example", "specification": "example", "isCompliant": true, "totalChecks": 1, "passedChecks": 1, "failedChecks": 1 } ], "summary": { "totalChecks": 1, "passedChecks": 1, "failedChecks": 1, "categories": [ { "category": "example", "passedChecks": 1, "failedChecks": 1 } ] }, "documentInfo": { "pages": 1, "tagged": true, "language": "example", "structureElements": 1, "fonts": [ { "name": "example", "embedded": true, "type": "example" } ], "images": 1 }, "failures": [ { "profile": "example", "clause": "example", "testNumber": 1, "category": "example", "message": "example", "location": "example", "errorDetails": "example" } ], "metadata": { "title": "example", "subject": "example", "author": "example", "creator": "example", "producer": "example", "creationDate": "example" } }, "pdf": "example"}PDF uploaded successfully
Invalid request, empty HTML, or JSON/upload conflict
Rendering failed
Upload target rejected the request or was unreachable