Get Status

PdfFromDocxRequest

Converts a DOC or DOCX document to PDF.

Generates a PDF document from web assets.

PdfGenerateRequest

Generates a PDF document from HTML and web technologies.

Merges multiple PDF documents into a single PDF document.

PdfMergeRequest

Splits a PDF document into 2 PDF documents. Returns a zip file containing the 2 documents. Each document is named after the original document with a suffix added to indicate the range of pages it contains.

PdfSplitRequest

Splits a PDF document into 2 PDF documents.

PdfExtractRequest

Extract a range of pages from a PDF document.

PdfInsertRequest

Insert a PDF document into another PDF document at a specified page.

Returns a list of form fields detected in the PDF document, along with their location, options and requirements. For a more visual representation, use the /pdf/form/mark endpoint.

Detect form fields in a PDF document

Returns a modified PDF document with form fields marked with a green border, and hover text showing the field name.

Mark form fields in a PDF document

Returns a modified PDF document with filled form fields. A subset of fields can be filled.

Fill form fields in a PDF document

Form

ErrorSchema

A human-readable message. This field may also provide additional context to the error code.

GetStatusResponse

FormDetectRequestOptions

FormDetectResponseItem

FormDetectResponseItemIsChecked

FormDetectResponseItemIsCombed

FormDetectResponseItemIsEditable

FormDetectResponseItemIsEditableType

FormDetectResponseItemIsMutuallyExclusive

FormDetectResponseItemType

FormFillRequestOptions

Fields to fill or change in the PDF document.

FormFillRequestOptionsFieldsItem

FormFillRequestOptionsFieldsItemChecked

Name of the field to fill. This must match an exact name from the PDF document. To detect all fields, use the /pdf/form/fields endpoint, or use the /pdf/form/mark endpoint to get an annotated PDF with each detected field.

FormFillRequestOptionsFieldsItemThree

FormFillRequestOptionsFieldsItemTwo

FormFillRequestOptionsFieldsItemTwoType

FormFillRequestOptionsFieldsItemValue

FormMarkRequestOptions

PdfExtractRequestOptions

PdfFromDocxRequestOptions

Whether to keep the text formatting of the variables in the document. Default is true.

Map of template literals to replace in the document.

Conversion options. This field is required even if empty.

PdfGenerateRequestOptions

Generate a test document instead of a production document. The generated document will contain a watermark. Defaults to true.

If enabled, the document will be hosted by FileForge and a presigned URL will be returned.

If host is enabled, the expiration date of the presigned URL. Defaults to 7 days from now. Cannot exceed 7 days from now.

The name of the generated PDF file. Defaults to document. The file name should not contain extensions nor path traversals.

PdfInsertRequestOptions

The page number to insert the document at

PdfMergeRequestOptions

PdfSplitRequestOptions

The page number to split the document at (the page will be included in the first document)