Conversion API

Generate a PDF and return a temporary download URL

Generates a PDF from a URL, Base64-encoded HTML, or a published template ID with template data, then returns a JSON response with a downloadable document URL. By default, files stored in PDFBolt's temporary storage expire after 24 hours. You can provide customS3PresignedUrl to upload the PDF directly to your own S3-compatible bucket.

post/v1/sync

Request

  • Base URL: https://api.pdfbolt.com
  • URL: https://api.pdfbolt.com/v1/sync
  • Auth: API key in header API-KEY

Request body

SyncConversionRequest required(unresolved $ref)

Response

PDF generated successfully. The response contains the conversion result.

requestIdstring uuid required

Unique identifier for the request.

status'SUCCESS' required

Always SUCCESS for successful Sync responses.

errorCodeunknown required
errorMessageunknown required
documentUrlstring uri nullable required

URL to the generated PDF, or null when custom S3 upload is used.

expiresAtstring date-time nullable required

Expiration timestamp for PDFs in PDFBolt's temporary storage, or null when custom S3 upload is used.

isAsyncfalse required

Always false for the Sync endpoint.

durationinteger required

PDF conversion time in milliseconds.

documentSizeMbnumber required

Generated document size in megabytes.

isCustomS3Bucketboolean required

Whether the generated PDF was uploaded to a user-provided S3-compatible bucket.

Changes

No recorded changes to this operation across all 1 revision of this API.