Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.box.com/llms.txt

Use this file to discover all available pages before exploring further.

A PDF representation provides a predictable way to embed documents in mobile and web applications. PDF representations support watermarks if the original file has been watermarked. PDF representations are generated upon uploading the source file to Box, though a watermarked PDF is generated upon fetching the watermarked file for the first time.

​
The process

To get a PDF representation follow the following steps
  • by passing the x-rep-hints-header for the desired file type [pdf].
  • by calling the url_template, replacing the {+asset_path} with an the page of the PDF to request, for example 1.pdf.

​
Watermarked PDFs

To retrieve a watermarked PDF the underlying file itself needs to be watermarked in Box. You can watermark a file either via the Box web application or using the API. Once watermarked, a watermarked PDF representation of the file is generated.