Generate a PDF from a URL or raw HTML. Provide either 'url' or 'html', not both.

Upload a PDF to PDFGate so it can be referenced by other operations. Provide either 'filePath' (local path) or 'url'.

Retrieve metadata for a stored PDFGate document by its ID.

Delete a PDFGate document.

Flatten an interactive PDF into a static, non-editable PDF. Creates a new document; does not overwrite the original.

Extract form field values from a fillable PDF. Returns a JSON object mapping field names to their values.

Add interactive form fields to a stored PDF — from placeholder tags (refined via fieldOverrides) and/or explicitly positioned fields.

Compress/optimise a PDF to reduce file size without changing visual content.

Encrypt a PDF with a password and optional permission restrictions. Produces a new document; the original is unchanged.

Apply a text or image watermark to a PDF. For type='text' provide 'text'; for type='image' provide 'watermarkImagePath'.

Download the raw PDF bytes of a stored document, returned as an embedded resource. For a shareable link instead, use get_document.

Create a signing envelope from one or more existing PDFGate documents. Returns an envelope in 'created' status; call send_envelope to dispatch signing emails.

Send a created envelope to its recipients. PDFGate dispatches signing emails with secure, OTP-protected links that expire after 30 days.

Retrieve the current state of an envelope including its status, document progress, and per-recipient signing status.

Create a PDFGate webhook subscription. The response includes a signing secret — store it securely to verify incoming event signatures.

Retrieve a PDFGate webhook subscription by its ID.

Delete a PDFGate webhook subscription. Future events will no longer be delivered to the associated endpoint.