Foxit Cloud API

Foxit Cloud API integration (Productivity, Design & Media). Imported from open-connector.

Credentials form21 toolshttps://servicesapi.foxitsoftware.cn/api

POST

fuxin_upload_file

Upload one source file to Foxit Cloud API and return the reusable Foxit document ID.

/file/upload

1 parameter

Param	Type	Required	Description
file	object	required	A file source provided as a public URL or Base64 payload.

GET

fuxin_get_task

Fetch one Foxit task status and return the normalized task progress details.

/task

1 parameter

Param	Type	Required	Description
taskId	string	required	The Foxit task ID to query.

GET

fuxin_download_file

Download one Foxit result document and upload it to local transit storage.

/download

2 parameters

Param	Type	Required	Description
docId	string	required	The Foxit document ID to download.
fileName	string	optional	Optional output file name passed through to Foxit download.

GET

fuxin_get_user_stock

Fetch the remaining Foxit Services API and Embed API quota for the connected credential.

/user/stock

POST

fuxin_create_pdf_from_html

Create a PDF from HTML content, an HTML file, or a webpage URL in Foxit.

/document/createFromHtml

POST

fuxin_convert_document

Convert one PDF into Word, Excel, PowerPoint, image, or text with Foxit.

/document/convert

4 parameters

Param	Type	Required	Description
docId	string	optional	An existing Foxit document ID returned by upload_file or a previous task.
file	object	optional	A file source provided as a public URL or Base64 payload.
outputFormat	string	required	The target format that Foxit should convert the PDF into.
imageConfig	object	optional	The image conversion options accepted by Foxit.

POST

fuxin_compare_documents

Compare two PDF documents with Foxit and submit a diff task.

/document/compare

6 parameters

Param	Type	Required	Description
baseDocId	string	optional	The Foxit document ID for the baseline PDF when baseFile is omitted.
baseFile	object	optional	A file source provided as a public URL or Base64 payload.
compareDocId	string	optional	The Foxit document ID for the comparison PDF when compareFile is omitted.
compareFile	object	optional	A file source provided as a public URL or Base64 payload.
resultType	string	optional	Whether Foxit should return a JSON diff or a rendered PDF diff.
compareType	string	optional	Whether Foxit should compare all changes or only text changes.

POST

fuxin_protect_document

Protect one PDF with passwords and permissions in Foxit.

/document/protect

5 parameters

Param	Type	Required	Description
docId	string	optional	An existing Foxit document ID returned by upload_file or a previous task.
file	object	optional	A file source provided as a public URL or Base64 payload.
passwordProtection	object	required	The password settings used when protecting a PDF.
permission	array	optional	The Foxit permission flags to keep on the protected PDF.
encryptionAlgorithm	string	required	The Foxit encryption algorithm used to protect the PDF.

POST

fuxin_manipulate_document_pages

Delete, rotate, or move PDF pages with Foxit.

/document/manipulation

3 parameters

Param	Type	Required	Description
docId	string	optional	An existing Foxit document ID returned by upload_file or a previous task.
file	object	optional	A file source provided as a public URL or Base64 payload.
config	array	required	The ordered list of page manipulation operations.

POST

fuxin_merge_documents

Merge multiple PDF documents into a single PDF with Foxit.

/document/combine

3 parameters

Param	Type	Required	Description
docIds	array	optional	The document IDs to merge in order.
zipFile	object	optional	A file source provided as a public URL or Base64 payload.
config	object	optional	The merge options accepted by Foxit.

POST

fuxin_split_document

Split one PDF into multiple smaller files with Foxit.

/document/split

3 parameters

Param	Type	Required	Description
docId	string	optional	An existing Foxit document ID returned by upload_file or a previous task.
file	object	optional	A file source provided as a public URL or Base64 payload.
pageCount	integer	required	The number of pages that each split file should contain.

POST

fuxin_compress_document

Compress one PDF with a chosen Foxit compression level.

/document/compress

3 parameters

Param	Type	Required	Description
docId	string	optional	An existing Foxit document ID returned by upload_file or a previous task.
file	object	optional	A file source provided as a public URL or Base64 payload.
compressionLevel	string	required	The Foxit compression level to apply.

POST

fuxin_remove_password_from_document

Remove the password from one protected PDF with Foxit.

/document/removePassword

3 parameters

Param	Type	Required	Description
docId	string	optional	An existing Foxit document ID returned by upload_file or a previous task.
file	object	optional	A file source provided as a public URL or Base64 payload.
password	string	required	The password used to open the protected document before Foxit removes it.

POST

fuxin_linearize_document

Linearize one PDF to improve incremental web viewing in Foxit.

/document/linearize

2 parameters

Param	Type	Required	Description
docId	string	optional	An existing Foxit document ID returned by upload_file or a previous task.
file	object	optional	A file source provided as a public URL or Base64 payload.

POST

fuxin_flatten_document

Flatten annotations and form fields into the page content of one PDF with Foxit.

/document/flatten

3 parameters

Param	Type	Required	Description
docId	string	optional	An existing Foxit document ID returned by upload_file or a previous task.
file	object	optional	A file source provided as a public URL or Base64 payload.
pageRange	string	optional	The optional page range, such as 1-30, 1,3,5, or all.

POST

fuxin_extract_document

Extract text or embedded images from one PDF with Foxit.

/document/extract

4 parameters

Param	Type	Required	Description
docId	string	optional	An existing Foxit document ID returned by upload_file or a previous task.
file	object	optional	A file source provided as a public URL or Base64 payload.
mode	string	required	Whether Foxit should extract text or embedded images.
pageRange	string	optional	The optional page range, such as 1-30, 1,3,5, or all.

POST

fuxin_get_pages_basic_info

Submit one PDF for page-size and rotation analysis in Foxit.

/document/pagesBasicInfo

3 parameters

Param	Type	Required	Description
docId	string	optional	An existing Foxit document ID returned by upload_file or a previous task.
file	object	optional	A file source provided as a public URL or Base64 payload.
pageRange	string	optional	The optional page range, such as 1-30, 1,3,5, or all.

POST

fuxin_check_pages_are_scanned

Submit one PDF for scanned-page detection in Foxit.

/document/pagesIsScanned

3 parameters

Param	Type	Required	Description
docId	string	optional	An existing Foxit document ID returned by upload_file or a previous task.
file	object	optional	A file source provided as a public URL or Base64 payload.
pageRange	string	optional	The optional page range, such as 1-30, 1,3,5, or all.

POST

fuxin_ocr_document

Run OCR on one PDF or image document with Foxit.

/document/ocr

4 parameters

Param	Type	Required	Description
docId	string	optional	An existing Foxit document ID returned by upload_file or a previous task.
file	object	optional	A file source provided as a public URL or Base64 payload.
lang	string	optional	The OCR language used by Foxit.
outputFormat	string	optional	The OCR output format returned by Foxit.

POST

fuxin_convert_office_document_to_images

Convert one Office document into a ZIP of page images with Foxit.

/document/office2image

5 parameters

Param	Type	Required	Description
docId	string	optional	An existing Foxit document ID returned by upload_file or a previous task.
file	object	optional	A file source provided as a public URL or Base64 payload.
format	string	required	The input Office document format that Foxit should convert to images.
dpi	integer	optional	The output image DPI between 1 and 1000.
destImgSuffix	string	optional	The image file suffix Foxit should generate for each page.

POST

fuxin_watermark_document

Add a text or image watermark to one PDF with Foxit.

/document/watermark

17 parameters

Param	Type	Required	Description
docId	string	optional	An existing Foxit document ID returned by upload_file or a previous task.
file	object	optional	A file source provided as a public URL or Base64 payload.
imageDocId	string	optional	An existing Foxit document ID for the watermark image when type is imageObject.
imageFile	object	optional	A file source provided as a public URL or Base64 payload.
pageRange	string	optional	The optional page range, such as 1-30, 1,3,5, or all.
type	string	optional	Whether Foxit should use a text watermark or an image watermark.
position	integer	optional	The watermark anchor position between 0 and 8.
offsetX	number	optional	The horizontal watermark offset in points.
offsetY	number	optional	The vertical watermark offset in points.
flagOnTopOfPage	integer	optional	Whether the watermark stays above page content where 1=true and 0=false.
flagNoPrint	integer	optional	Whether the watermark is excluded from printing where 1=true and 0=false.
flagInvisible	integer	optional	Whether the watermark is invisible where 1=true and 0=false.
scaleX	number	optional	The horizontal watermark scale factor.
scaleY	number	optional	The vertical watermark scale factor.
rotation	number	optional	The watermark rotation angle.
opacity	integer	optional	The watermark opacity between 0 and 100.
font	object	optional	The text watermark font configuration.