Skip to main content
POST
/
api
/
documents
/
{documentId}
cURL
curl --request POST \
  --url https://htmldocs.com/api/documents/{documentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "props": {},
  "format": "pdf",
  "size": "<string>",
  "orientation": "portrait"
}'
This response does not have an example.
This endpoint is for generating a document based on a template you’ve published to a team. To publish a document, see the publish command. You can find the ids of your published documents in the dashboard.

Authorizations

​
Authorization
string
header
required

API key or authentication token

Path Parameters

​
documentId
string
required

UUID or custom ID of the document template

Body

application/json
​
props
object
required

Props to pass to the document component

​
format
enum<string>
default:pdf

Response format. pdf returns a binary PDF file, base64 returns the PDF encoded as base64 in JSON, json returns a URL to download the PDF. Defaults to pdf

Available options:
pdf,
base64,
json
​
size
string

Page size (A3, A4, A5, letter, legal, or custom size like '8.5in 11in')

​
orientation
enum<string>
Available options:
portrait,
landscape

Response

Generated document in requested format

Binary PDF file (when format=pdf)