Share a PDF
everypage_share_pdfUpload a PDF and get a tracked share link, embeddable iframe, and QR code. Apply passcode, expiry, or download limits, then monitor who reads it.
Instructions
Upload a PDF to EveryPage and get back a tracked share link, an embeddable iframe, and a QR code URL. Give either path (a PDF on this machine) or url (an https link to a PDF). Share settings such as a passcode, expiry or download permission can be applied in the same call. Every read of the resulting link is tracked - use everypage_get_readership afterwards to see who read it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | https:// link to a PDF. Fetched without credentials, then uploaded. | |
| path | No | Absolute path to a PDF on this machine, e.g. /Users/you/proposal.pdf. | |
| slug | No | Vanity link name on the owner's custom domain: lowercase letters, digits and hyphens. Requires the Pro plan. | |
| pageTo | No | Last page readers may see. Set pageFrom and pageTo to 0 to clear the limit (clearing is never plan-gated). | |
| filename | No | Display name for the document. Defaults to the file's own name. | |
| pageFrom | No | First page readers may see (1-based). Pair with pageTo. Pages outside the window are never sent to the browser. Requires the Pro plan. | |
| passcode | No | Require this passcode to open the document. Requires the Basic plan or higher. | |
| viewLimit | No | Burn the link after this many views. 0 clears the limit. Requires the Basic plan or higher. | |
| watermark | No | Stamp the reader's identity across the pages. Requires the Pro plan. | |
| askReceipt | No | Ask readers to confirm they received the document. Requires the Basic plan or higher. | |
| viewerMode | No | How the document is presented: standard scroll, page-turning flipbook, swipe, or magazine spread. | |
| expiryHours | No | Expire the link this many hours from now. Capped by plan: 7 days on free, 365 days on basic, unlimited on pro. | |
| gateDomains | No | Restrict the email gate to these domains, e.g. ["acme.com"]. An empty array clears the restriction. Requires the Pro plan. | |
| neverExpire | No | Keep the link alive permanently. Overrides expiryHours. Requires the Pro plan. | |
| notifyOnView | No | Email the owner when someone reads the document. Requires the Basic plan or higher. | |
| requireEmail | No | Make readers give an email address before they can read. Requires the Pro plan. | |
| allowDownload | No | Let readers download the original PDF. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| size | No | Size of the uploaded PDF in bytes. | |
| uuid | Yes | The document's canonical UUID. | |
| qr_url | Yes | PNG QR code for the share link. Public - no credentials needed to fetch it. | |
| shortId | No | The document's short share-URL alias. | |
| fileName | No | The document's display name. | |
| shareUrl | Yes | The tracked share link to send to a reader. | |
| warnings | No | Non-fatal problems. The operation succeeded; these describe what could not be applied. | |
| embed_code | Yes | Ready-to-paste <iframe> that embeds the document. | |
| totalPages | No | ||
| appliedSettings | No | Settings that were applied. |