Supported Smart PDF Commands in Foxit AI Assistant

Scenario

Name

Description or Example

Details

1

Convert

convert-to-file

Convert the current pdf document to a specified file

The type of file to convert.Valid values are:word,word-2003,xml-spreadsheet-2003,excel,ppt,png,jpeg,jpeg2000,tiff,bmp,xml-stardard,rtf,txt,accessible-txt,html,office,image,other.

2

Convert

convert-from

Convert to a pdf file from a specified source.

blank:Convert from a blank page. clipboard:Convert from clipboard. url:Convert from a url or web page. local:Convert from a local selected file.

3

Convert

export-all-image

Export all the images to another type from the current pdf document

The save type. Default by 'jpg'. Must be one of "png,jpg,tiff,bmp"

4

Convert

combine-files

Combine multiple documents and generate a new PDF document

5

Convert

convert-files-to-pdfs

Convert the specified files to pdf files (Multiple files)

6

OCR

quick-ocr

Extract or recognize the text from the current pdf document.

The page range string, which value format will be like "1,3-5,10", seperated by comma.1:Represents the first page.3-5:Represents the third page to the fifth page.10:Represents the tenth page.Refers to the option 1. 'current' represents the current page.

7

OCR

enable-automatic-ocr

Enable the automatic ocr function. Turn off or disable automatic OCR for scanned document

Default by true. true:Enable the automatic ocr function. false:Disable the automatic ocr function.

8

PDF Optimizer

optimize-file

Optimize size of the current pdf document. Reduce the size of the current pdf document.

The version of the optimized pdf file. Must be one of "1.3,1.4,1.5,1.6,1.7".

9

PDF Optimizer

audit-space-usage

Audit the space usage of the current pdf document.

10

View

enable-fast-view

Enable Fast Web View in a PDF. Enable or disable fast web view setting in preferences

Default by true. true:Enable the fast web view. false:Disable the fast web view.

11

View

list-cloud-documents

List all the documents from the user cloud

12

View

go-to

Jump the view to a specified page of the current document.

The page number, which starts from 1, 1 for the first page.

13

View

zoom

zoom the current view or page to a specified ratio

fitWidth:Fit the page width,fitPage:Fit the page width and height,fitHeight:Fit the page width and height,fitVisible:Fit the visible rect of page,z:Set the zoom level. Value should be number or the percentage number,which represents the percentage

14

View

layout

Set the layout of the pages for displaying

The layout of the pages. Valid values should be strings.single-page-view-mode:Single page view mode,continuous-view-mode:Continuous page view mode,facing-page-view-mode:Facing page view mode,facing-continuous-page-view-mode:Continuous facing page view mode,separate-cover-page-view-mode:Separate cover page view mode,h-continuous-view-mode:Horizontal Continuous page view mode.

15

View

change-bg-color

Change the background color of the document viewer

The color of background, valid value format will be css style or a valid color value like:#FF00FF,rgb(0,0,0),rgba(0,0,0,1)

16

View

show-properties

View document properties and View object data and metadata

17

View

update-properties

Add a description to Document Properties

18

View

create-properties

Create document properties

19

Search

Search

Search the specified text. If find one, then go to first result.

wholeWordsOnly:Whether to match exactly the whole word,the value should be true or false, false by default. caseSensitive:Whether to Case sensitive or not,the value should be true or false, false by default.

20

Search

search-replace

Search the specified text, go to first found result, then replace it with a new text

0:Do not match whole word either case sensitive. 1:Whether to match the whole word. 2:Whether to match case sensitive. 3:Match both whole word and case sensitive.

21

Edit_Add image

add-image-to-pdf

Add an image to the current pdf document

22

Edit_add text

add-text

Add a text to the current pdf document

The text to add

23

Edit_add shapes

add-path

Add a path to the current pdf document

The path to add. Must be one of "line,rectangle,round_rectangle, ellipse"

24

Edit_add shapes

add-shading

Add a shading to the current pdf document.

The shape to add. Must be one of "rectangle,round_rectangle, ellipse"

25

Edit_Link

convert-texts-to-links

Create links for link text on the pages

The page range string, which value format will be like "current page", "all pages", "1,3-5,10", separated by comma.1:Represents the first page.3-5:Represents the third page to the fifth page.10:Represents the tenth page.Refers to the option 1.

26

Edit_Link

remove-links

Remove links on the pages

The page range string, which value format will be like "current page", "all pages", "1,3-5,10", separated by comma.1:Represents the first page.3-5:Represents the third page to the fifth page.10:Represents the tenth page.Refers to the option 1.

27

Edit_Link

view-links

View Web links on current page

28

Edit_Link

add-links

Add a network link to redirect to the corresponding link address, Or add a document page index link to jump to the corresponding document page

The link url, which can be a web link、a document page index or "current page"

29

Edit_Destination

add-destination

Add a new destination on the current page

The destination name

30

Edit_Destination

remove-destinations

Remove destinations on the pages

The page range string, which value format will be like "current page", "all pages", "1,3-5,10", seperated by comma.1:Represents the first page.3-5:Represents the third page to the fifth page.10:Represents the tenth page.Refers to the option 1.

31

Edit_File Attachment

add-attachment

Add an attachment to the document.

32

Edit_File Attachment

toggle-attachment

Show\hide the attachments panel in this pdf.

33

Edit_File Attachment

delete-attachment

Delete all attachments in this pdf

34

Edit_Image Annotation

add-image-annotation

Add an image annotation in this pdf

35

Edit_Audio&Video

add-media-annotation

Add an Audio or Video in this pdf

36

Edit_Layer

toggle-layers

Show\hide the layers panel in this pdf

Toggle show\hide the layers panel in this pdf.

37

Edit_Layer

add-layer

Add a layer in this pdf

38

Edit_Layer

set-layer-properties

set layer properties

39

Edit_Thumbnail

embed-all-thumbnails

Embed all page thumbnails into this pdf

40

Edit_Thumbnail

remove-all-embedded-thumbnails

Remove all embedded thumbnails from this pdf

41

Edit_Bookmark

toggle-bookmarks

Show\hide the bookmarks panel in this pdf.

42

Edit_Bookmark

save-bookmark

Save the current view as a bookmark.

43

Edit_Bookmark

operate-bookmark

Delete or edit bookmarks

44

Edit_Bookmark

create-bookmark-from-structure

Create bookmarks from structure

45

Edit_Article

toggle-articles

Show\hide the articles panel in this pdf

46

Edit_Article

add-article

Add an article box in this pdf

47

Edit_Article

operate-article

Delete or edit articles

48

Edit_Object

edit-object

Enable edit the annotation object in current pdf document

49

Form

open-form-preference

Open the form preference setting dialog

50

Form

enable-form-wizard

Enable "automatically calculate file values". Enable or disable the setting in preferences

Default by true. true:Enable the setting, false:Disable the setting.

51

Form

form-recognition

Run form field recognition for the current document

52

Form

export-form-to-file

Export thseare form in the document as a file

53

Form

append-form-data

Collect form data from the current document by appending form data to an existing sheet

54

Form

combine-form-data

Collect form data from the current document by combine data from forms into a sheet

55

Form

create-form-field

Enable the tool to create form fields and fillable forms

The filed active type to be created. Default by 'text'. Must be one of "button,radio,list,signature,date,check,text,image"

56

Form

save-form

Save the document which includes form data to a new pdf file

57

Form

reset-form

clear or reset unsaved form entries

58

Form

add-form-tooltip

Add tooltip for the form field in the current pdf document

59

Form

open-form-order

Open the form fields order setting panel for set form field navigation

60

Form

edit-static-xfa

Start to edit the static XFA form.

61

Print

print

Print the form

62

Organize_Crop

remove-white-margins

remove white margins on the pages

63

Organize

rotate-pages

Rotate the page to a certain angle

64

Organize

extract-page-keyword

Extract the pages with the specified keyword

65

Organize

insert-page-from-file

insert a file before or after the destination page

66

Organize

insert-page-from-clipboard

insert clipboard data before or after the destination page

67

Organize

insert-page-with-blank

insert a blank page before or after the destination page

68

Organize

insert-page-into-file

insert pages into other files

69

Organize_header/footer

add-header-footer

add headers or footers to the page

70

Organize_header/footer

update-header-footer

update headers or footers to the page

71

Organize_header/footer

remove-header-footer

remove all headers and footers from this document.

72

Organize_bates

add-bates-numbering

Add Bates numbering to the page

73

Organize_bates

remove-bates-numbering

Remove Bates numbering from this document

74

Organize_Watermark

add-watermark

add a watermark to this document

75

Organize_Watermark

update-watermark

update watermark to this document

76

Organize_Watermark

remove-watermark

remove all watermarks

77

Organize_Background

add-background

add background to this document

78

Organize_Background

update-background

update background to this document

79

Organize_Background

remove-background

remove all backgrounds

80

Organize

delete-page

Delete the page with the specified page indexes.

The page number, which value format will be like "1,3-5,10", seperated by comma.1:Represents the first page.3-5:Represents the third page to the fifth page.10:Represents the tenth page.

modeOne:Extract page as one PDF. modeSplit:Extract pages as several PDFs by comma(,) sign. modeEach:Extract each pages as a PDF.

The page number, which value format will be like "1,3-5,10", seperated by comma.1:Represents the first page.3-5:Represents the third page to the fifth page.10:Represents the tenth page.

before:Insert before the destination page index. after:Insert after the destination page index.

before:Insert before the destination page index. after:Insert after the destination page index. end:Insert at the end of the document. Default by end

From the page index of the source pdf file. Value is the page index

0:Split the page by number,per number pages. 1:Split the pages by page range. 2:Split the pages by top level bookmarks. 3:Split the pages by blank page. PerNumber:

The specified page index to swap from

81

Organize

extract-page

Extract the pages with the specified page indexes.

82

Organize

reverse-page

Reverse the pages with the specified page indexes.

83

Organize

move-page

Move the pages with the specified page indexes to a new location.

84

Organize

duplicate-page

Duplicate the pages with the specified page indexes

85

Organize

replace-page

Replace the pages with the specified page indexes with a new PDF file

86

Organize

split-page

Split the pages with the specified page indexes

87

Organize

swap-page

Swap the pages with the specified page indexes

88

Organize_Flatten

flatten-pages

flatten selected pages

The page range string, which value format will be like "current page", "all pages", "1,3-5,10", seperated by comma.1:Represents the first page.3-5:Represents the third page to the fifth page.10:Represents the tenth page.Refers to the option 1.