Convert to PDF

POST https://api.pdfrest.com/pdf

Convert any one of the following input file types to PDF:

  • Microsoft Word (.doc, .docx)
  • Microsoft Excel (.xls, .xlsx)
  • Microsoft PowerPoint (.ppt, .pptx)
  • PostScript and Encapsulated PostScript (.ps, .eps)
  • JPEG (.jpg, .jpeg)
  • TIF (.tif, .tiff)
  • BMP (.bmp)
  • PNG (.png)
  • HTML (.html)
  • HTML (from url)

Required form-data body parameters:

  • One of:
    • file - File to be uploaded and processed
    • id - Alphanumeric ID (UUID) of existing file on server to be processed

Optional form-data body parameters (bold = default):

  • compression - Select lossy or lossless image compression.
  • downsample - Downsample images during conversion (75, 150, 300, 600, or 1200). Or, preserve original resolutions with off.
  • tagged_pdf - Create a tagged PDF document, required for accessibility compliance. Set to on or off.
  • page_size - Can be letter, legal, ledger, A3, A4, or A5
  • page_margin - A number followed by either 'in' or 'mm'. Examples include:
    • 1in
    • 8mm
    • 2.5in
    • 10.25mm
    • 0in
  • page_orientation - Set to either portrait or landscape.
  • web_layout - For web pages with responsive design, select the intended web layout. Accepts desktop, tablet, or mobile.

Request Body

[{"name"=>"file", "value"=>nil, "datatype"=>"null"}, {"name"=>"id", "value"=>"xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "datatype"=>"string"}, {"name"=>"url", "value"=>"", "datatype"=>"null"}, {"name"=>"output", "value"=>"pdfrest_pdf", "datatype"=>"string"}, {"name"=>"compression", "value"=>"lossy", "datatype"=>"string"}, {"name"=>"downsample", "value"=>"300", "datatype"=>"number"}, {"name"=>"tagged_pdf", "value"=>"off", "datatype"=>"string"}, {"name"=>"page_size", "value"=>"letter", "datatype"=>"string"}, {"name"=>"page_margin", "value"=>"1in", "datatype"=>"string"}, {"name"=>"page_orientation", "value"=>"portrait", "datatype"=>"string"}, {"name"=>"web_layout", "value"=>"desktop", "datatype"=>"string"}]

HEADERS

KeyDatatypeRequiredDescription
Api-Keystring