Socket
Socket
Sign inDemoInstall

asposepdfcloud

Package Overview
Dependencies
Maintainers
2
Versions
68
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

asposepdfcloud

Aspose.PDF Cloud is a REST API for creating and editing PDF files. Most popular features proposed by Aspose.PDF Cloud: PDF to Word, Convert PDF to Image, Merge PDF, Split PDF, Add Images to PDF, Rotate PDF. It can also be used to convert PDF files to diff


Version published
Weekly downloads
742
decreased by-40.54%
Maintainers
2
Weekly downloads
 
Created
Source

npm npm bundle size node-current npm type definitions GitHub license

Node.js REST API to Process PDF in Cloud

Aspose.PDF Cloud is a true REST API that enables you to perform a wide range of document processing operations including creation, manipulation, conversion and rendering of PDF documents in the cloud.

Our Cloud SDKs are wrappers around REST API in various programming languages, allowing you to process documents in language of your choice quickly and easily, gaining all benefits of strong types and IDE highlights. This repository contains new generation SDKs for Aspose.PDF Cloud and examples.

These SDKs are now fully supported. If you have any questions, see any bugs or have enhancement request, feel free to reach out to us at Free Support Forums.

Extract Text & Images of a PDF document online https://products.aspose.app/pdf/parser.

PDF Processing Features

  • Add PDF document's header & footer in text or image format.
  • Add tables & stamps (text or image) to PDF documents.
  • Append multiple PDF documents to an existing file.
  • Work with PDF attachments, annotations, & form fields.
  • Apply encryption or decryption to PDF documents & set a password.
  • Delete all stamps & tables from a page or entire PDF document.
  • Delete a specific stamp or table from the PDF document by its ID.
  • Replace single or multiple instances of text on a PDF page or from the entire document.
  • Extensive support for converting PDF documents to various other file formats.
  • Extract various elements of PDF files & make PDF documents optimized.

Read & Write PDF Formats

PDF, EPUB, HTML, TeX, SVG, XML, XPS, FDF, XFDF

Save PDF As

XLS, XLSX, PPTX, DOC, DOCX, MobiXML, JPEG, EMF, PNG, BMP, GIF, TIFF, Text

Read PDF Formats

MHT, PCL, PS, XSLFO, MD

Enhancements in Version 22.4

  • A new version of Aspose.PDF Cloud was prepared using the latest version of Aspose.PDF for .NET.

Installation

NPM

From the command line:

$ npm install asposepdfcloud --save

Get PDF Page Annotations in Node.Js

	// Get your ClientId and ClientSecret from https://dashboard.aspose.cloud (free registration required).
	const pdfApi = new PdfApi("MY_CLIENT_ID", "MY_CLIENT_SECRET");

	let pageNumber = 1;
	let pdfDocName = "example.pdf";
	let remoteFolder = "folderName";

	pdfApi.getPageAnnotations(pdfDocName, pageNumber, null, remoteFolder)
	.then((result) => {
		console.log(result.response);
		console.log(result.body);
	});

Unit Tests

Aspose PDF SDK includes a suite of unit tests within the "test" subdirectory. These Unit Tests also serves as examples of how to use the Aspose PDF SDK.

Licensing

All Aspose.PDF Cloud SDKs are licensed under MIT License.

Documentation for API Endpoints

All URIs are relative to https://api.aspose.cloud/v3.0/

ClassMethodHTTP requestDescription
PdfApicopyFilePUT /pdf/storage/file/copy/{srcPath}Copy file
PdfApicopyFolderPUT /pdf/storage/folder/copy/{srcPath}Copy folder
PdfApicreateFolderPUT /pdf/storage/folder/{path}Create the folder
PdfApideleteAnnotationDELETE /pdf/{name}/annotations/{annotationId}Delete document annotation by ID
PdfApideleteBookmarkDELETE /pdf/{name}/bookmarks/bookmark/{bookmarkPath}Delete document bookmark by ID.
PdfApideleteDocumentAnnotationsDELETE /pdf/{name}/annotationsDelete all annotations from the document
PdfApideleteDocumentBookmarksDELETE /pdf/{name}/bookmarks/treeDelete all document bookmarks.
PdfApideleteDocumentLinkAnnotationsDELETE /pdf/{name}/linksDelete all link annotations from the document
PdfApideleteDocumentStampsDELETE /pdf/{name}/stampsDelete all stamps from the document
PdfApideleteDocumentTablesDELETE /pdf/{name}/tablesDelete all tables from the document
PdfApideleteFieldDELETE /pdf/{name}/fields/{fieldName}Delete document field by name.
PdfApideleteFileDELETE /pdf/storage/file/{path}Delete file
PdfApideleteFolderDELETE /pdf/storage/folder/{path}Delete folder
PdfApideleteImageDELETE /pdf/{name}/images/{imageId}Delete image from document page.
PdfApideleteLinkAnnotationDELETE /pdf/{name}/links/{linkId}Delete document page link annotation by ID
PdfApideletePageDELETE /pdf/{name}/pages/{pageNumber}Delete document page by its number.
PdfApideletePageAnnotationsDELETE /pdf/{name}/pages/{pageNumber}/annotationsDelete all annotations from the page
PdfApideletePageLinkAnnotationsDELETE /pdf/{name}/pages/{pageNumber}/linksDelete all link annotations from the page
PdfApideletePageStampsDELETE /pdf/{name}/pages/{pageNumber}/stampsDelete all stamps from the page
PdfApideletePageTablesDELETE /pdf/{name}/pages/{pageNumber}/tablesDelete all tables from the page
PdfApideletePropertiesDELETE /pdf/{name}/documentpropertiesDelete custom document properties.
PdfApideletePropertyDELETE /pdf/{name}/documentproperties/{propertyName}Delete document property.
PdfApideleteStampDELETE /pdf/{name}/stamps/{stampId}Delete document stamp by ID
PdfApideleteTableDELETE /pdf/{name}/tables/{tableId}Delete document table by ID
PdfApidownloadFileGET /pdf/storage/file/{path}Download file
PdfApigetBookmarkGET /pdf/{name}/bookmarks/bookmark/{bookmarkPath}Read document bookmark.
PdfApigetBookmarksGET /pdf/{name}/bookmarks/list/{bookmarkPath}Read document bookmarks node list.
PdfApigetCaretAnnotationGET /pdf/{name}/annotations/caret/{annotationId}Read document page caret annotation by ID.
PdfApigetCheckBoxFieldGET /pdf/{name}/fields/checkbox/{fieldName}Read document checkbox field by name.
PdfApigetCircleAnnotationGET /pdf/{name}/annotations/circle/{annotationId}Read document page circle annotation by ID.
PdfApigetComboBoxFieldGET /pdf/{name}/fields/combobox/{fieldName}Read document combobox field by name.
PdfApigetDiscUsageGET /pdf/storage/discGet disc usage
PdfApigetDocumentGET /pdf/{name}Read common document info.
PdfApigetDocumentAnnotationsGET /pdf/{name}/annotationsRead document page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases.
PdfApigetDocumentAttachmentByIndexGET /pdf/{name}/attachments/{attachmentIndex}Read document attachment info by its index.
PdfApigetDocumentAttachmentsGET /pdf/{name}/attachmentsRead document attachments info.
PdfApigetDocumentBookmarksGET /pdf/{name}/bookmarks/treeRead document bookmarks tree.
PdfApigetDocumentCaretAnnotationsGET /pdf/{name}/annotations/caretRead document caret annotations.
PdfApigetDocumentCheckBoxFieldsGET /pdf/{name}/fields/checkboxRead document checkbox fields.
PdfApigetDocumentCircleAnnotationsGET /pdf/{name}/annotations/circleRead document circle annotations.
PdfApigetDocumentComboBoxFieldsGET /pdf/{name}/fields/comboboxRead document combobox fields.
PdfApigetDocumentDisplayPropertiesGET /pdf/{name}/displaypropertiesRead document display properties.
PdfApigetDocumentFileAttachmentAnnotationsGET /pdf/{name}/annotations/fileattachmentRead document FileAttachment annotations.
PdfApigetDocumentFreeTextAnnotationsGET /pdf/{name}/annotations/freetextRead document free text annotations.
PdfApigetDocumentHighlightAnnotationsGET /pdf/{name}/annotations/highlightRead document highlight annotations.
PdfApigetDocumentInkAnnotationsGET /pdf/{name}/annotations/inkRead document ink annotations.
PdfApigetDocumentLineAnnotationsGET /pdf/{name}/annotations/lineRead document line annotations.
PdfApigetDocumentListBoxFieldsGET /pdf/{name}/fields/listboxRead document listbox fields.
PdfApigetDocumentMovieAnnotationsGET /pdf/{name}/annotations/movieRead document movie annotations.
PdfApigetDocumentPolygonAnnotationsGET /pdf/{name}/annotations/polygonRead document polygon annotations.
PdfApigetDocumentPolyLineAnnotationsGET /pdf/{name}/annotations/polylineRead document polyline annotations.
PdfApigetDocumentPopupAnnotationsGET /pdf/{name}/annotations/popupRead document popup annotations.
PdfApigetDocumentPopupAnnotationsByParentGET /pdf/{name}/annotations/{annotationId}/popupRead document popup annotations by parent id.
PdfApigetDocumentPropertiesGET /pdf/{name}/documentpropertiesRead document properties.
PdfApigetDocumentPropertyGET /pdf/{name}/documentproperties/{propertyName}Read document property by name.
PdfApigetDocumentRadioButtonFieldsGET /pdf/{name}/fields/radiobuttonRead document radiobutton fields.
PdfApigetDocumentRedactionAnnotationsGET /pdf/{name}/annotations/redactionRead document redaction annotations.
PdfApigetDocumentScreenAnnotationsGET /pdf/{name}/annotations/screenRead document screen annotations.
PdfApigetDocumentSignatureFieldsGET /pdf/{name}/fields/signatureRead document signature fields.
PdfApigetDocumentSoundAnnotationsGET /pdf/{name}/annotations/soundRead document sound annotations.
PdfApigetDocumentSquareAnnotationsGET /pdf/{name}/annotations/squareRead document square annotations.
PdfApigetDocumentSquigglyAnnotationsGET /pdf/{name}/annotations/squigglyRead document squiggly annotations.
PdfApigetDocumentStampAnnotationsGET /pdf/{name}/annotations/stampRead document stamp annotations.
PdfApigetDocumentStampsGET /pdf/{name}/stampsRead document stamps.
PdfApigetDocumentStrikeOutAnnotationsGET /pdf/{name}/annotations/strikeoutRead document StrikeOut annotations.
PdfApigetDocumentTablesGET /pdf/{name}/tablesRead document tables.
PdfApigetDocumentTextAnnotationsGET /pdf/{name}/annotations/textRead document text annotations.
PdfApigetDocumentTextBoxFieldsGET /pdf/{name}/fields/textboxRead document text box fields.
PdfApigetDocumentUnderlineAnnotationsGET /pdf/{name}/annotations/underlineRead document underline annotations.
PdfApigetDownloadDocumentAttachmentByIndexGET /pdf/{name}/attachments/{attachmentIndex}/downloadDownload document attachment content by its index.
PdfApigetEpubInStorageToPdfGET /pdf/create/epubConvert EPUB file (located on storage) to PDF format and return resulting file in response.
PdfApigetExportFieldsFromPdfToFdfInStorageGET /pdf/{name}/export/fdfExport fields from from PDF in storage to FDF file.
PdfApigetExportFieldsFromPdfToXfdfInStorageGET /pdf/{name}/export/xfdfExport fields from from PDF in storage to XFDF file.
PdfApigetExportFieldsFromPdfToXmlInStorageGET /pdf/{name}/export/xmlExport fields from from PDF in storage to XML file.
PdfApigetFieldGET /pdf/{name}/fields/{fieldName}Get document field by name.
PdfApigetFieldsGET /pdf/{name}/fieldsGet document fields.
PdfApigetFileAttachmentAnnotationGET /pdf/{name}/annotations/fileattachment/{annotationId}Read document page FileAttachment annotation by ID.
PdfApigetFileAttachmentAnnotationDataGET /pdf/{name}/annotations/fileattachment/{annotationId}/dataRead document page FileAttachment annotation by ID.
PdfApigetFilesListGET /pdf/storage/folder/{path}Get all files and folders within a folder
PdfApigetFileVersionsGET /pdf/storage/version/{path}Get file versions
PdfApigetFreeTextAnnotationGET /pdf/{name}/annotations/freetext/{annotationId}Read document page free text annotation by ID.
PdfApigetHighlightAnnotationGET /pdf/{name}/annotations/highlight/{annotationId}Read document page highlight annotation by ID.
PdfApigetHtmlInStorageToPdfGET /pdf/create/htmlConvert HTML file (located on storage) to PDF format and return resulting file in response.
PdfApigetImageGET /pdf/{name}/images/{imageId}Read document image by ID.
PdfApigetImageExtractAsGifGET /pdf/{name}/images/{imageId}/extract/gifExtract document image in GIF format
PdfApigetImageExtractAsJpegGET /pdf/{name}/images/{imageId}/extract/jpegExtract document image in JPEG format
PdfApigetImageExtractAsPngGET /pdf/{name}/images/{imageId}/extract/pngExtract document image in PNG format
PdfApigetImageExtractAsTiffGET /pdf/{name}/images/{imageId}/extract/tiffExtract document image in TIFF format
PdfApigetImagesGET /pdf/{name}/pages/{pageNumber}/imagesRead document images.
PdfApigetImportFieldsFromFdfInStorageGET /pdf/{name}/import/fdfUpdate fields from FDF file in storage.
PdfApigetImportFieldsFromXfdfInStorageGET /pdf/{name}/import/xfdfUpdate fields from XFDF file in storage.
PdfApigetImportFieldsFromXmlInStorageGET /pdf/{name}/import/xmlImport from XML file (located on storage) to PDF format and return resulting file in response.
PdfApigetInkAnnotationGET /pdf/{name}/annotations/ink/{annotationId}Read document page ink annotation by ID.
PdfApigetLineAnnotationGET /pdf/{name}/annotations/line/{annotationId}Read document page line annotation by ID.
PdfApigetLinkAnnotationGET /pdf/{name}/links/{linkId}Read document link annotation by ID.
PdfApigetListBoxFieldGET /pdf/{name}/fields/listbox/{fieldName}Read document listbox field by name.
PdfApigetMarkdownInStorageToPdfGET /pdf/create/markdownConvert MD file (located on storage) to PDF format and return resulting file in response.
PdfApigetMhtInStorageToPdfGET /pdf/create/mhtConvert MHT file (located on storage) to PDF format and return resulting file in response.
PdfApigetMovieAnnotationGET /pdf/{name}/annotations/movie/{annotationId}Read document page movie annotation by ID.
PdfApigetPageGET /pdf/{name}/pages/{pageNumber}Read document page info.
PdfApigetPageAnnotationsGET /pdf/{name}/pages/{pageNumber}/annotationsRead document page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases.
PdfApigetPageCaretAnnotationsGET /pdf/{name}/pages/{pageNumber}/annotations/caretRead document page caret annotations.
PdfApigetPageCheckBoxFieldsGET /pdf/{name}/page/{pageNumber}/fields/checkboxRead document page checkbox fields.
PdfApigetPageCircleAnnotationsGET /pdf/{name}/pages/{pageNumber}/annotations/circleRead document page circle annotations.
PdfApigetPageComboBoxFieldsGET /pdf/{name}/page/{pageNumber}/fields/comboboxRead document page combobox fields.
PdfApigetPageConvertToBmpGET /pdf/{name}/pages/{pageNumber}/convert/bmpConvert document page to Bmp image and return resulting file in response.
PdfApigetPageConvertToEmfGET /pdf/{name}/pages/{pageNumber}/convert/emfConvert document page to Emf image and return resulting file in response.
PdfApigetPageConvertToGifGET /pdf/{name}/pages/{pageNumber}/convert/gifConvert document page to Gif image and return resulting file in response.
PdfApigetPageConvertToJpegGET /pdf/{name}/pages/{pageNumber}/convert/jpegConvert document page to Jpeg image and return resulting file in response.
PdfApigetPageConvertToPngGET /pdf/{name}/pages/{pageNumber}/convert/pngConvert document page to Png image and return resulting file in response.
PdfApigetPageConvertToTiffGET /pdf/{name}/pages/{pageNumber}/convert/tiffConvert document page to Tiff image and return resulting file in response.
PdfApigetPageFileAttachmentAnnotationsGET /pdf/{name}/pages/{pageNumber}/annotations/fileattachmentRead document page FileAttachment annotations.
PdfApigetPageFreeTextAnnotationsGET /pdf/{name}/pages/{pageNumber}/annotations/freetextRead document page free text annotations.
PdfApigetPageHighlightAnnotationsGET /pdf/{name}/pages/{pageNumber}/annotations/highlightRead document page highlight annotations.
PdfApigetPageInkAnnotationsGET /pdf/{name}/pages/{pageNumber}/annotations/inkRead document page ink annotations.
PdfApigetPageLineAnnotationsGET /pdf/{name}/pages/{pageNumber}/annotations/lineRead document page line annotations.
PdfApigetPageLinkAnnotationGET /pdf/{name}/pages/{pageNumber}/links/{linkId}Read document page link annotation by ID.
PdfApigetPageLinkAnnotationsGET /pdf/{name}/pages/{pageNumber}/linksRead document page link annotations.
PdfApigetPageListBoxFieldsGET /pdf/{name}/page/{pageNumber}/fields/listboxRead document page listbox fields.
PdfApigetPageMovieAnnotationsGET /pdf/{name}/pages/{pageNumber}/annotations/movieRead document page movie annotations.
PdfApigetPagePolygonAnnotationsGET /pdf/{name}/pages/{pageNumber}/annotations/polygonRead document page polygon annotations.
PdfApigetPagePolyLineAnnotationsGET /pdf/{name}/pages/{pageNumber}/annotations/polylineRead document page polyline annotations.
PdfApigetPagePopupAnnotationsGET /pdf/{name}/pages/{pageNumber}/annotations/popupRead document page popup annotations.
PdfApigetPageRadioButtonFieldsGET /pdf/{name}/page/{pageNumber}/fields/radiobuttonRead document page radiobutton fields.
PdfApigetPageRedactionAnnotationsGET /pdf/{name}/pages/{pageNumber}/annotations/redactionRead document page redaction annotations.
PdfApigetPagesGET /pdf/{name}/pagesRead document pages info.
PdfApigetPageScreenAnnotationsGET /pdf/{name}/pages/{pageNumber}/annotations/screenRead document page screen annotations.
PdfApigetPageSignatureFieldsGET /pdf/{name}/page/{pageNumber}/fields/signatureRead document page signature fields.
PdfApigetPageSoundAnnotationsGET /pdf/{name}/pages/{pageNumber}/annotations/soundRead document page sound annotations.
PdfApigetPageSquareAnnotationsGET /pdf/{name}/pages/{pageNumber}/annotations/squareRead document page square annotations.
PdfApigetPageSquigglyAnnotationsGET /pdf/{name}/pages/{pageNumber}/annotations/squigglyRead document page squiggly annotations.
PdfApigetPageStampAnnotationsGET /pdf/{name}/pages/{pageNumber}/annotations/stampRead document page stamp annotations.
PdfApigetPageStampsGET /pdf/{name}/pages/{pageNumber}/stampsRead page document stamps.
PdfApigetPageStrikeOutAnnotationsGET /pdf/{name}/pages/{pageNumber}/annotations/strikeoutRead document page StrikeOut annotations.
PdfApigetPageTablesGET /pdf/{name}/pages/{pageNumber}/tablesRead document page tables.
PdfApigetPageTextGET /pdf/{name}/pages/{pageNumber}/textRead page text items.
PdfApigetPageTextAnnotationsGET /pdf/{name}/pages/{pageNumber}/annotations/textRead document page text annotations.
PdfApigetPageTextBoxFieldsGET /pdf/{name}/page/{pageNumber}/fields/textboxRead document page text box fields.
PdfApigetPageUnderlineAnnotationsGET /pdf/{name}/pages/{pageNumber}/annotations/underlineRead document page underline annotations.
PdfApigetPclInStorageToPdfGET /pdf/create/pclConvert PCL file (located on storage) to PDF format and return resulting file in response.
PdfApigetPdfAInStorageToPdfGET /pdf/create/pdfaConvert PDFA file (located on storage) to PDF format and return resulting file in response.
PdfApigetPdfInStorageToDocGET /pdf/{name}/convert/docConverts PDF document (located on storage) to DOC format and returns resulting file in response content
PdfApigetPdfInStorageToEpubGET /pdf/{name}/convert/epubConverts PDF document (located on storage) to EPUB format and returns resulting file in response content
PdfApigetPdfInStorageToHtmlGET /pdf/{name}/convert/htmlConverts PDF document (located on storage) to Html format and returns resulting file in response content
PdfApigetPdfInStorageToMobiXmlGET /pdf/{name}/convert/mobixmlConverts PDF document (located on storage) to MOBIXML format and returns resulting ZIP archive file in response content.
PdfApigetPdfInStorageToPdfAGET /pdf/{name}/convert/pdfaConverts PDF document (located on storage) to PdfA format and returns resulting file in response content
PdfApigetPdfInStorageToPptxGET /pdf/{name}/convert/pptxConverts PDF document (located on storage) to PPTX format and returns resulting file in response content
PdfApigetPdfInStorageToSvgGET /pdf/{name}/convert/svgConverts PDF document (located on storage) to SVG format and returns resulting file in response content
PdfApigetPdfInStorageToTeXGET /pdf/{name}/convert/texConverts PDF document (located on storage) to TeX format and returns resulting file in response content
PdfApigetPdfInStorageToTiffGET /pdf/{name}/convert/tiffConverts PDF document (located on storage) to TIFF format and returns resulting file in response content
PdfApigetPdfInStorageToXlsGET /pdf/{name}/convert/xlsConverts PDF document (located on storage) to XLS format and returns resulting file in response content
PdfApigetPdfInStorageToXlsxGET /pdf/{name}/convert/xlsxConverts PDF document (located on storage) to XLSX format and returns resulting file in response content
PdfApigetPdfInStorageToXmlGET /pdf/{name}/convert/xmlConverts PDF document (located on storage) to XML format and returns resulting file in response content
PdfApigetPdfInStorageToXpsGET /pdf/{name}/convert/xpsConverts PDF document (located on storage) to XPS format and returns resulting file in response content
PdfApigetPolygonAnnotationGET /pdf/{name}/annotations/polygon/{annotationId}Read document page polygon annotation by ID.
PdfApigetPolyLineAnnotationGET /pdf/{name}/annotations/polyline/{annotationId}Read document page polyline annotation by ID.
PdfApigetPopupAnnotationGET /pdf/{name}/annotations/popup/{annotationId}Read document page popup annotation by ID.
PdfApigetPsInStorageToPdfGET /pdf/create/psConvert PS file (located on storage) to PDF format and return resulting file in response.
PdfApigetRadioButtonFieldGET /pdf/{name}/fields/radiobutton/{fieldName}Read document RadioButton field by name.
PdfApigetRedactionAnnotationGET /pdf/{name}/annotations/redaction/{annotationId}Read document page redaction annotation by ID.
PdfApigetScreenAnnotationGET /pdf/{name}/annotations/screen/{annotationId}Read document page screen annotation by ID.
PdfApigetScreenAnnotationDataGET /pdf/{name}/annotations/screen/{annotationId}/dataRead document page screen annotation by ID.
PdfApigetSignatureFieldGET /pdf/{name}/fields/signature/{fieldName}Read document signature field by name.
PdfApigetSoundAnnotationGET /pdf/{name}/annotations/sound/{annotationId}Read document page sound annotation by ID.
PdfApigetSoundAnnotationDataGET /pdf/{name}/annotations/sound/{annotationId}/dataRead document page sound annotation by ID.
PdfApigetSquareAnnotationGET /pdf/{name}/annotations/square/{annotationId}Read document page square annotation by ID.
PdfApigetSquigglyAnnotationGET /pdf/{name}/annotations/squiggly/{annotationId}Read document page squiggly annotation by ID.
PdfApigetStampAnnotationGET /pdf/{name}/annotations/stamp/{annotationId}Read document page stamp annotation by ID.
PdfApigetStampAnnotationDataGET /pdf/{name}/annotations/stamp/{annotationId}/dataRead document page stamp annotation by ID.
PdfApigetStrikeOutAnnotationGET /pdf/{name}/annotations/strikeout/{annotationId}Read document page StrikeOut annotation by ID.
PdfApigetSvgInStorageToPdfGET /pdf/create/svgConvert SVG file (located on storage) to PDF format and return resulting file in response.
PdfApigetTableGET /pdf/{name}/tables/{tableId}Read document page table by ID.
PdfApigetTeXInStorageToPdfGET /pdf/create/texConvert TeX file (located on storage) to PDF format and return resulting file in response.
PdfApigetTextGET /pdf/{name}/textRead document text.
PdfApigetTextAnnotationGET /pdf/{name}/annotations/text/{annotationId}Read document page text annotation by ID.
PdfApigetTextBoxFieldGET /pdf/{name}/fields/textbox/{fieldName}Read document text box field by name.
PdfApigetUnderlineAnnotationGET /pdf/{name}/annotations/underline/{annotationId}Read document page underline annotation by ID.
PdfApigetVerifySignatureGET /pdf/{name}/verifySignatureVerify signature document.
PdfApigetWebInStorageToPdfGET /pdf/create/webConvert web page to PDF format and return resulting file in response.
PdfApigetWordsPerPageGET /pdf/{name}/pages/wordCountGet number of words per document page.
PdfApigetXfaPdfInStorageToAcroFormGET /pdf/{name}/convert/xfatoacroformConverts PDF document which contains XFA form (located on storage) to PDF with AcroForm and returns resulting file response content
PdfApigetXmlInStorageToPdfGET /pdf/create/xmlConvert XML file (located on storage) to PDF format and return resulting file in response.
PdfApigetXpsInStorageToPdfGET /pdf/create/xpsConvert XPS file (located on storage) to PDF format and return resulting file in response.
PdfApigetXslFoInStorageToPdfGET /pdf/create/xslfoConvert XslFo file (located on storage) to PDF format and return resulting file in response.
PdfApimoveFilePUT /pdf/storage/file/move/{srcPath}Move file
PdfApimoveFolderPUT /pdf/storage/folder/move/{srcPath}Move folder
PdfApiobjectExistsGET /pdf/storage/exist/{path}Check if file or folder exists
PdfApipostAppendDocumentPOST /pdf/{name}/appendDocumentAppend document to existing one.
PdfApipostBookmarkPOST /pdf/{name}/bookmarks/bookmark/{bookmarkPath}Add document bookmarks.
PdfApipostChangePasswordDocumentInStoragePOST /pdf/{name}/changepasswordChange document password in storage.
PdfApipostCheckBoxFieldsPOST /pdf/{name}/fields/checkboxAdd document checkbox fields.
PdfApipostComboBoxFieldsPOST /pdf/{name}/fields/comboboxAdd document combobox fields.
PdfApipostCreateDocumentPOST /pdf/{name}Create empty document.
PdfApipostCreateFieldPOST /pdf/{name}/fieldsCreate field.
PdfApipostDecryptDocumentInStoragePOST /pdf/{name}/decryptDecrypt document in storage.
PdfApipostDocumentImageFooterPOST /pdf/{name}/footer/imageAdd document image footer.
PdfApipostDocumentImageHeaderPOST /pdf/{name}/header/imageAdd document image header.
PdfApipostDocumentPageNumberStampsPOST /pdf/{name}/stamps/pagenumberAdd document page number stamps.
PdfApipostDocumentTextFooterPOST /pdf/{name}/footer/textAdd document text footer.
PdfApipostDocumentTextHeaderPOST /pdf/{name}/header/textAdd document text header.
PdfApipostDocumentTextReplacePOST /pdf/{name}/text/replaceDocument's replace text method.
PdfApipostEncryptDocumentInStoragePOST /pdf/{name}/encryptEncrypt document in storage.
PdfApipostFlattenDocumentPOST /pdf/{name}/flattenFlatten the document.
PdfApipostImportFieldsFromFdfPOST /pdf/{name}/import/fdfUpdate fields from FDF file in request.
PdfApipostImportFieldsFromXfdfPOST /pdf/{name}/import/xfdfUpdate fields from XFDF file in request.
PdfApipostImportFieldsFromXmlPOST /pdf/{name}/import/xmlUpdate fields from XML file in request.
PdfApipostInsertImagePOST /pdf/{name}/pages/{pageNumber}/imagesInsert image to document page.
PdfApipostListBoxFieldsPOST /pdf/{name}/fields/listboxAdd document listbox fields.
PdfApipostMovePagePOST /pdf/{name}/pages/{pageNumber}/movePageMove page to new position.
PdfApipostOptimizeDocumentPOST /pdf/{name}/optimizeOptimize document.
PdfApipostPageCaretAnnotationsPOST /pdf/{name}/pages/{pageNumber}/annotations/caretAdd document page caret annotations.
PdfApipostPageCertifyPOST /pdf/{name}/pages/{pageNumber}/certifyCertify document page.
PdfApipostPageCircleAnnotationsPOST /pdf/{name}/pages/{pageNumber}/annotations/circleAdd document page circle annotations.
PdfApipostPageFileAttachmentAnnotationsPOST /pdf/{name}/pages/{pageNumber}/annotations/fileattachmentAdd document page FileAttachment annotations.
PdfApipostPageFreeTextAnnotationsPOST /pdf/{name}/pages/{pageNumber}/annotations/freetextAdd document page free text annotations.
PdfApipostPageHighlightAnnotationsPOST /pdf/{name}/pages/{pageNumber}/annotations/highlightAdd document page highlight annotations.
PdfApipostPageImageStampsPOST /pdf/{name}/pages/{pageNumber}/stamps/imageAdd document page image stamps.
PdfApipostPageInkAnnotationsPOST /pdf/{name}/pages/{pageNumber}/annotations/inkAdd document page ink annotations.
PdfApipostPageLineAnnotationsPOST /pdf/{name}/pages/{pageNumber}/annotations/lineAdd document page line annotations.
PdfApipostPageLinkAnnotationsPOST /pdf/{name}/pages/{pageNumber}/linksAdd document page link annotations.
PdfApipostPageMovieAnnotationsPOST /pdf/{name}/pages/{pageNumber}/annotations/movieAdd document page movie annotations.
PdfApipostPagePdfPageStampsPOST /pdf/{name}/pages/{pageNumber}/stamps/pdfpageAdd document pdf page stamps.
PdfApipostPagePolygonAnnotationsPOST /pdf/{name}/pages/{pageNumber}/annotations/polygonAdd document page polygon annotations.
PdfApipostPagePolyLineAnnotationsPOST /pdf/{name}/pages/{pageNumber}/annotations/polylineAdd document page polyline annotations.
PdfApipostPageRedactionAnnotationsPOST /pdf/{name}/pages/{pageNumber}/annotations/redactionAdd document page redaction annotations.
PdfApipostPageScreenAnnotationsPOST /pdf/{name}/pages/{pageNumber}/annotations/screenAdd document page screen annotations.
PdfApipostPageSoundAnnotationsPOST /pdf/{name}/pages/{pageNumber}/annotations/soundAdd document page sound annotations.
PdfApipostPageSquareAnnotationsPOST /pdf/{name}/pages/{pageNumber}/annotations/squareAdd document page square annotations.
PdfApipostPageSquigglyAnnotationsPOST /pdf/{name}/pages/{pageNumber}/annotations/squigglyAdd document page squiggly annotations.
PdfApipostPageStampAnnotationsPOST /pdf/{name}/pages/{pageNumber}/annotations/stampAdd document page stamp annotations.
PdfApipostPageStrikeOutAnnotationsPOST /pdf/{name}/pages/{pageNumber}/annotations/strikeoutAdd document page StrikeOut annotations.
PdfApipostPageTablesPOST /pdf/{name}/pages/{pageNumber}/tablesAdd document page tables.
PdfApipostPageTextAnnotationsPOST /pdf/{name}/pages/{pageNumber}/annotations/textAdd document page text annotations.
PdfApipostPageTextReplacePOST /pdf/{name}/pages/{pageNumber}/text/replacePage's replace text method.
PdfApipostPageTextStampsPOST /pdf/{name}/pages/{pageNumber}/stamps/textAdd document page text stamps.
PdfApipostPageUnderlineAnnotationsPOST /pdf/{name}/pages/{pageNumber}/annotations/underlineAdd document page underline annotations.
PdfApipostPopupAnnotationPOST /pdf/{name}/annotations/{annotationId}/popupAdd document popup annotations.
PdfApipostRadioButtonFieldsPOST /pdf/{name}/fields/radiobuttonAdd document RadioButton fields.
PdfApipostSignatureFieldPOST /pdf/{name}/fields/signatureAdd document signature field.
PdfApipostSignDocumentPOST /pdf/{name}/signSign document.
PdfApipostSignPagePOST /pdf/{name}/pages/{pageNumber}/signSign page.
PdfApipostSplitDocumentPOST /pdf/{name}/splitSplit document to parts.
PdfApipostTextBoxFieldsPOST /pdf/{name}/fields/textboxAdd document text box fields.
PdfApiputAddNewPagePUT /pdf/{name}/pagesAdd new page to end of the document.
PdfApiputAddTextPUT /pdf/{name}/pages/{pageNumber}/textAdd text to PDF document page.
PdfApiputAnnotationsFlattenPUT /pdf/{name}/annotations/flattenFlattens the annotations of the specified types
PdfApiputBookmarkPUT /pdf/{name}/bookmarks/bookmark/{bookmarkPath}Update document bookmark.
PdfApiputCaretAnnotationPUT /pdf/{name}/annotations/caret/{annotationId}Replace document caret annotation
PdfApiputChangePasswordDocumentPUT /pdf/changepasswordChange document password from content.
PdfApiputCheckBoxFieldPUT /pdf/{name}/fields/checkbox/{fieldName}Replace document checkbox field
PdfApiputCircleAnnotationPUT /pdf/{name}/annotations/circle/{annotationId}Replace document circle annotation
PdfApiputComboBoxFieldPUT /pdf/{name}/fields/combobox/{fieldName}Replace document combobox field
PdfApiputCreateDocumentPUT /pdf/{name}Create empty document.
PdfApiputDecryptDocumentPUT /pdf/decryptDecrypt document from content.
PdfApiputDocumentDisplayPropertiesPUT /pdf/{name}/displaypropertiesUpdate document display properties.
PdfApiputEncryptDocumentPUT /pdf/encryptEncrypt document from content.
PdfApiputEpubInStorageToPdfPUT /pdf/{name}/create/epubConvert EPUB file (located on storage) to PDF format and upload resulting file to storage.
PdfApiputExportFieldsFromPdfToFdfInStoragePUT /pdf/{name}/export/fdfExport fields from from PDF in storage to FDF file in storage.
PdfApiputExportFieldsFromPdfToXfdfInStoragePUT /pdf/{name}/export/xfdfExport fields from from PDF in storage to XFDF file in storage.
PdfApiputExportFieldsFromPdfToXmlInStoragePUT /pdf/{name}/export/xmlExport fields from from PDF in storage to XML file in storage.
PdfApiputFieldsFlattenPUT /pdf/{name}/fields/flattenFlatten form fields in document.
PdfApiputFileAttachmentAnnotationPUT /pdf/{name}/annotations/fileattachment/{annotationId}Replace document FileAttachment annotation
PdfApiputFileAttachmentAnnotationDataExtractPUT /pdf/{name}/annotations/fileattachment/{annotationId}/data/extractExtract document FileAttachment annotation content to storage
PdfApiputFreeTextAnnotationPUT /pdf/{name}/annotations/freetext/{annotationId}Replace document free text annotation
PdfApiputHighlightAnnotationPUT /pdf/{name}/annotations/highlight/{annotationId}Replace document highlight annotation
PdfApiputHtmlInStorageToPdfPUT /pdf/{name}/create/htmlConvert HTML file (located on storage) to PDF format and upload resulting file to storage.
PdfApiputImageExtractAsGifPUT /pdf/{name}/images/{imageId}/extract/gifExtract document image in GIF format to folder
PdfApiputImageExtractAsJpegPUT /pdf/{name}/images/{imageId}/extract/jpegExtract document image in JPEG format to folder
PdfApiputImageExtractAsPngPUT /pdf/{name}/images/{imageId}/extract/pngExtract document image in PNG format to folder
PdfApiputImageExtractAsTiffPUT /pdf/{name}/images/{imageId}/extract/tiffExtract document image in TIFF format to folder
PdfApiputImageInStorageToPdfPUT /pdf/{name}/create/imagesConvert image file (located on storage) to PDF format and upload resulting file to storage.
PdfApiputImagesExtractAsGifPUT /pdf/{name}/pages/{pageNumber}/images/extract/gifExtract document images in GIF format to folder.
PdfApiputImagesExtractAsJpegPUT /pdf/{name}/pages/{pageNumber}/images/extract/jpegExtract document images in JPEG format to folder.
PdfApiputImagesExtractAsPngPUT /pdf/{name}/pages/{pageNumber}/images/extract/pngExtract document images in PNG format to folder.
PdfApiputImagesExtractAsTiffPUT /pdf/{name}/pages/{pageNumber}/images/extract/tiffExtract document images in TIFF format to folder.
PdfApiputImportFieldsFromFdfInStoragePUT /pdf/{name}/import/fdfUpdate fields from FDF file in storage.
PdfApiputImportFieldsFromXfdfInStoragePUT /pdf/{name}/import/xfdfUpdate fields from XFDF file in storage.
PdfApiputImportFieldsFromXmlInStoragePUT /pdf/{name}/import/xmlUpdate fields from XML file in storage.
PdfApiputInkAnnotationPUT /pdf/{name}/annotations/ink/{annotationId}Replace document ink annotation
PdfApiputLineAnnotationPUT /pdf/{name}/annotations/line/{annotationId}Replace document line annotation
PdfApiputLinkAnnotationPUT /pdf/{name}/links/{linkId}Replace document page link annotations
PdfApiputListBoxFieldPUT /pdf/{name}/fields/listbox/{fieldName}Replace document listbox field
PdfApiputMarkdownInStorageToPdfPUT /pdf/{name}/create/markdownConvert MD file (located on storage) to PDF format and upload resulting file to storage.
PdfApiputMergeDocumentsPUT /pdf/{name}/mergeMerge a list of documents.
PdfApiputMhtInStorageToPdfPUT /pdf/{name}/create/mhtConvert MHT file (located on storage) to PDF format and upload resulting file to storage.
PdfApiputMovieAnnotationPUT /pdf/{name}/annotations/movie/{annotationId}Replace document movie annotation
PdfApiputPageAddStampPUT /pdf/{name}/pages/{pageNumber}/stampAdd page stamp.
PdfApiputPageConvertToBmpPUT /pdf/{name}/pages/{pageNumber}/convert/bmpConvert document page to bmp image and upload resulting file to storage.
PdfApiputPageConvertToEmfPUT /pdf/{name}/pages/{pageNumber}/convert/emfConvert document page to emf image and upload resulting file to storage.
PdfApiputPageConvertToGifPUT /pdf/{name}/pages/{pageNumber}/convert/gifConvert document page to gif image and upload resulting file to storage.
PdfApiputPageConvertToJpegPUT /pdf/{name}/pages/{pageNumber}/convert/jpegConvert document page to Jpeg image and upload resulting file to storage.
PdfApiputPageConvertToPngPUT /pdf/{name}/pages/{pageNumber}/convert/pngConvert document page to png image and upload resulting file to storage.
PdfApiputPageConvertToTiffPUT /pdf/{name}/pages/{pageNumber}/convert/tiffConvert document page to Tiff image and upload resulting file to storage.
PdfApiputPclInStorageToPdfPUT /pdf/{name}/create/pclConvert PCL file (located on storage) to PDF format and upload resulting file to storage.
PdfApiputPdfAInStorageToPdfPUT /pdf/{name}/create/pdfaConvert PDFA file (located on storage) to PDF format and upload resulting file to storage.
PdfApiputPdfInRequestToDocPUT /pdf/convert/docConverts PDF document (in request content) to DOC format and uploads resulting file to storage.
PdfApiputPdfInRequestToEpubPUT /pdf/convert/epubConverts PDF document (in request content) to EPUB format and uploads resulting file to storage.
PdfApiputPdfInRequestToHtmlPUT /pdf/convert/htmlConverts PDF document (in request content) to Html format and uploads resulting file to storage.
PdfApiputPdfInRequestToMobiXmlPUT /pdf/convert/mobixmlConverts PDF document (in request content) to MOBIXML format and uploads resulting ZIP archive file to storage.
PdfApiputPdfInRequestToPdfAPUT /pdf/convert/pdfaConverts PDF document (in request content) to PdfA format and uploads resulting file to storage.
PdfApiputPdfInRequestToPptxPUT /pdf/convert/pptxConverts PDF document (in request content) to PPTX format and uploads resulting file to storage.
PdfApiputPdfInRequestToSvgPUT /pdf/convert/svgConverts PDF document (in request content) to SVG format and uploads resulting file to storage.
PdfApiputPdfInRequestToTeXPUT /pdf/convert/texConverts PDF document (in request content) to TeX format and uploads resulting file to storage.
PdfApiputPdfInRequestToTiffPUT /pdf/convert/tiffConverts PDF document (in request content) to TIFF format and uploads resulting file to storage.
PdfApiputPdfInRequestToXlsPUT /pdf/convert/xlsConverts PDF document (in request content) to XLS format and uploads resulting file to storage.
PdfApiputPdfInRequestToXlsxPUT /pdf/convert/xlsxConverts PDF document (in request content) to XLSX format and uploads resulting file to storage.
PdfApiputPdfInRequestToXmlPUT /pdf/convert/xmlConverts PDF document (in request content) to XML format and uploads resulting file to storage.
PdfApiputPdfInRequestToXpsPUT /pdf/convert/xpsConverts PDF document (in request content) to XPS format and uploads resulting file to storage.
PdfApiputPdfInStorageToDocPUT /pdf/{name}/convert/docConverts PDF document (located on storage) to DOC format and uploads resulting file to storage
PdfApiputPdfInStorageToEpubPUT /pdf/{name}/convert/epubConverts PDF document (located on storage) to EPUB format and uploads resulting file to storage
PdfApiputPdfInStorageToHtmlPUT /pdf/{name}/convert/htmlConverts PDF document (located on storage) to Html format and uploads resulting file to storage
PdfApiputPdfInStorageToMobiXmlPUT /pdf/{name}/convert/mobixmlConverts PDF document (located on storage) to MOBIXML format and uploads resulting ZIP archive file to storage
PdfApiputPdfInStorageToPdfAPUT /pdf/{name}/convert/pdfaConverts PDF document (located on storage) to PdfA format and uploads resulting file to storage
PdfApiputPdfInStorageToPptxPUT /pdf/{name}/convert/pptxConverts PDF document (located on storage) to PPTX format and uploads resulting file to storage
PdfApiputPdfInStorageToSvgPUT /pdf/{name}/convert/svgConverts PDF document (located on storage) to SVG format and uploads resulting file to storage
PdfApiputPdfInStorageToTeXPUT /pdf/{name}/convert/texConverts PDF document (located on storage) to TeX format and uploads resulting file to storage
PdfApiputPdfInStorageToTiffPUT /pdf/{name}/convert/tiffConverts PDF document (located on storage) to TIFF format and uploads resulting file to storage
PdfApiputPdfInStorageToXlsPUT /pdf/{name}/convert/xlsConverts PDF document (located on storage) to XLS format and uploads resulting file to storage
PdfApiputPdfInStorageToXlsxPUT /pdf/{name}/convert/xlsxConverts PDF document (located on storage) to XLSX format and uploads resulting file to storage
PdfApiputPdfInStorageToXmlPUT /pdf/{name}/convert/xmlConverts PDF document (located on storage) to XML format and uploads resulting file to storage
PdfApiputPdfInStorageToXpsPUT /pdf/{name}/convert/xpsConverts PDF document (located on storage) to XPS format and uploads resulting file to storage
PdfApiputPolygonAnnotationPUT /pdf/{name}/annotations/polygon/{annotationId}Replace document polygon annotation
PdfApiputPolyLineAnnotationPUT /pdf/{name}/annotations/polyline/{annotationId}Replace document polyline annotation
PdfApiputPopupAnnotationPUT /pdf/{name}/annotations/popup/{annotationId}Replace document popup annotation
PdfApiputPrivilegesPUT /pdf/{name}/privilegesUpdate privilege document.
PdfApiputPsInStorageToPdfPUT /pdf/{name}/create/psConvert PS file (located on storage) to PDF format and upload resulting file to storage.
PdfApiputRadioButtonFieldPUT /pdf/{name}/fields/radiobutton/{fieldName}Replace document RadioButton field
PdfApiputRedactionAnnotationPUT /pdf/{name}/annotations/redaction/{annotationId}Replace document redaction annotation
PdfApiputReplaceImagePUT /pdf/{name}/images/{imageId}Replace document image.
PdfApiputScreenAnnotationPUT /pdf/{name}/annotations/screen/{annotationId}Replace document screen annotation
PdfApiputScreenAnnotationDataExtractPUT /pdf/{name}/annotations/screen/{annotationId}/data/extractExtract document screen annotation content to storage
PdfApiputSearchableDocumentPUT /pdf/{name}/ocrCreate searchable PDF document. Generate OCR layer for images in input PDF document.
PdfApiputSetPropertyPUT /pdf/{name}/documentproperties/{propertyName}Add/update document property.
PdfApiputSignatureFieldPUT /pdf/{name}/fields/signature/{fieldName}Replace document signature field.
PdfApiputSoundAnnotationPUT /pdf/{name}/annotations/sound/{annotationId}Replace document sound annotation
PdfApiputSoundAnnotationDataExtractPUT /pdf/{name}/annotations/sound/{annotationId}/data/extractExtract document sound annotation content to storage
PdfApiputSquareAnnotationPUT /pdf/{name}/annotations/square/{annotationId}Replace document square annotation
PdfApiputSquigglyAnnotationPUT /pdf/{name}/annotations/squiggly/{annotationId}Replace document squiggly annotation
PdfApiputStampAnnotationPUT /pdf/{name}/annotations/stamp/{annotationId}Replace document stamp annotation
PdfApiputStampAnnotationDataExtractPUT /pdf/{name}/annotations/stamp/{annotationId}/data/extractExtract document stamp annotation content to storage
PdfApiputStrikeOutAnnotationPUT /pdf/{name}/annotations/strikeout/{annotationId}Replace document StrikeOut annotation
PdfApiputSvgInStorageToPdfPUT /pdf/{name}/create/svgConvert SVG file (located on storage) to PDF format and upload resulting file to storage.
PdfApiputTablePUT /pdf/{name}/tables/{tableId}Replace document page table.
PdfApiputTeXInStorageToPdfPUT /pdf/{name}/create/texConvert TeX file (located on storage) to PDF format and upload resulting file to storage.
PdfApiputTextAnnotationPUT /pdf/{name}/annotations/text/{annotationId}Replace document text annotation
PdfApiputTextBoxFieldPUT /pdf/{name}/fields/textbox/{fieldName}Replace document text box field
PdfApiputUnderlineAnnotationPUT /pdf/{name}/annotations/underline/{annotationId}Replace document underline annotation
PdfApiputUpdateFieldPUT /pdf/{name}/fields/{fieldName}Update field.
PdfApiputUpdateFieldsPUT /pdf/{name}/fieldsUpdate fields.
PdfApiputWebInStorageToPdfPUT /pdf/{name}/create/webConvert web page to PDF format and upload resulting file to storage.
PdfApiputXfaPdfInRequestToAcroFormPUT /pdf/convert/xfatoacroformConverts PDF document which contains XFA form (in request content) to PDF with AcroForm and uploads resulting file to storage.
PdfApiputXfaPdfInStorageToAcroFormPUT /pdf/{name}/convert/xfatoacroformConverts PDF document which contains XFA form (located on storage) to PDF with AcroForm and uploads resulting file to storage
PdfApiputXmlInStorageToPdfPUT /pdf/{name}/create/xmlConvert XML file (located on storage) to PDF format and upload resulting file to storage.
PdfApiputXpsInStorageToPdfPUT /pdf/{name}/create/xpsConvert XPS file (located on storage) to PDF format and upload resulting file to storage.
PdfApiputXslFoInStorageToPdfPUT /pdf/{name}/create/xslfoConvert XslFo file (located on storage) to PDF format and upload resulting file to storage.
PdfApistorageExistsGET /pdf/storage/{storageName}/existCheck if storage exists
PdfApiuploadFilePUT /pdf/storage/file/{path}Upload file

Documentation for Models

ClassDescription
AnnotationProvides annotation.
AnnotationFlagsA set of flags specifying various characteristics of the annotation.
AnnotationInfoProvides annotation.
AnnotationsInfoObject representing a list of annotation info objects.
AnnotationsInfoResponseRepresents multiple annotations info reponse
AnnotationStateThe enumeration of states to which the original annotation can be set.
AnnotationType
AntialiasingProcessingTypeThis enum describes possible antialiasing measures during conversion
AsposeResponseBase class for all responses.
AttachmentProvides link to attachment.
AttachmentResponseRepresents response containing single attachment info
AttachmentsRepresents list of attachment.
AttachmentsResponseRepresents response containing multiple attachments info
BookmarkProvides link to bookmark.
BookmarkResponseRepresents response containing single bookmark info
BookmarksRepresents list of bookmark.
BookmarksResponseRepresents response containing multiple bookmarks info
BorderClass representing characteristics of annotation border.
BorderCornerStyleEnumerates the border corner styles for border.
BorderEffectDescribes effect which should be applied to the border of the annotations.
BorderInfoThis class represents border for graphics elements.
BorderStyleDescribes style of the annotation border.
BoxStyleRepresents an enumeration of available BoxStyle types.
CapStyleStyle of line ending of Ink annotation line.
CaptionPositionEnumeration of the annotation’s caption positioning.
CaretAnnotationProvides CaretAnnotation.
CaretAnnotationResponseRepresents response containing single caret annotation object
CaretAnnotationsObject representing a list of caret annotations.
CaretAnnotationsResponseRepresents response containing multiple caret annotation objects
CaretSymbolA symbol to be associated with the caret.
CellRepresents a cell of the table's row.
CellRecognized
CheckBoxFieldProvides CheckBoxField.
CheckBoxFieldResponseRepresents response containing single checkbox field object
CheckBoxFieldsObject representing a list of checkbox fields.
CheckBoxFieldsResponseRepresents response containing multiple checkbox field objects
ChoiceFieldProvides Choice field.
CircleAnnotationProvides CircleAnnotation.
CircleAnnotationResponseRepresents response containing single circle annotation object
CircleAnnotationsObject representing a list of circle annotations.
CircleAnnotationsResponseRepresents response containing multiple circle annotation objects
ColorRepresents color DTO.
ColorDepthUsed to specify the parameter value passed to a Tiff image device.
ColumnAdjustmentEnumerates column adjustment types.
ComboBoxFieldProvides ComboBoxField.
ComboBoxFieldResponseRepresents response containing single combobox field object
ComboBoxFieldsObject representing a list of combobox fields.
ComboBoxFieldsResponseRepresents response containing multiple combobox field objects
CommonFigureAnnotationProvides CommonFigureAnnotation.
CompressionTypeUsed to specify the parameter value passed to a Tiff image device.
CryptoAlgorithmRepresent type of cryptographic algorithm that used in encryption/decryption routines.
DashClass representing line dash pattern.
DefaultPageConfigProvides link to DefaultPageConfig.
DirectionText direction.
DiscUsageClass for disc space information.
DisplayPropertiesProvides link to DisplayProperties.
DisplayPropertiesResponseRepresents response containing DisplayProperties
DocFormatAllows to specify .doc or .docx file format.
DocMDPAccessPermissionTypeThe access permissions granted for this document. Valid values are: 1 - No changes to the document are permitted; any change to the document invalidates the signature. 2 - Permitted changes are filling in forms, instantiating page templates, and signing; other changes invalidate the signature. 3 - Permitted changes are the same as for 2, as well as annotation creation, deletion, and modification; other changes invalidate the signature.
DocRecognitionModeAllows to control how a PDF document is converted into a word processing document.
DocumentRepresents document DTO.
DocumentConfigProvides link to DocumentConfig.
DocumentPageResponseRepresents response containing single page info
DocumentPagesResponseRepresents response containing multiple pages info
DocumentPrivilegeRepresents the privileges for accessing Pdf file.
DocumentPropertiesRepresents list of PDF document properties.
DocumentPropertiesResponseRepresents response containing multiple document properties info
DocumentPropertyPdf document property.
DocumentPropertyResponseRepresents response containing single document property info
DocumentResponseRepresents response containing document info
EpubRecognitionModeWhen PDF file (that usually has fixed layout) is being converted, the conversion engine tries to perform grouping and multi-level analysis to restore the original document author's intent and produce result in flow layout. This property tunes that conversion for this or that desirable method of recognition of content.
ErrorError
ErrorDetailsThe error details
FieldRepresents form field.
FieldResponseRepresents response containing single field info
FieldsRepresents list of form fields.
FieldsResponseRepresents response containing multiple fields info
FieldTypeRepresents an enumeration of available field types.
FileAttachmentAnnotationProvides FileAttachmentAnnotation.
FileAttachmentAnnotationResponseRepresents response containing single FileAttachment annotation object
FileAttachmentAnnotationsObject representing a list of FileAttachment annotations.
FileAttachmentAnnotationsResponseRepresents response containing multiple FileAttachment annotation objects
FileIconAn icon to be used in displaying the annotation.
FilesListFiles list
FilesUploadResultFile upload result
FileVersionFile Version
FileVersionsFile versions FileVersion.
FontEncodingRulesThis enumeration defines rules which tune encoding logic
FontSavingModesEnumerates modes that can be used for saving of fonts referenced in saved PDF
FontStylesSpecifies style information applied to text.
FormFieldProvides form field.
FreeTextAnnotationProvides FreeTextAnnotation.
FreeTextAnnotationResponseRepresents response containing single free text annotation object
FreeTextAnnotationsObject representing a list of free text annotations.
FreeTextAnnotationsResponseRepresents response containing multiple free text annotation objects
FreeTextIntentEnumerates the intents of the free text annotation.
GraphInfoRepresents graphics info.
HighlightAnnotationProvides HighlightAnnotation.
HighlightAnnotationResponseRepresents response containing single highlight annotation object
HighlightAnnotationsObject representing a list of highlight annotations.
HighlightAnnotationsResponseRepresents response containing multiple highlight annotation objects
HorizontalAlignmentDescribes horizontal alignment.
HtmlDocumentTypeRepresents enumeration of the Html document types.
HtmlMarkupGenerationModesSometimes specific reqirments to created HTML are present. This enum defines HTML preparing modes that can be used during conversion of PDF to HTML to match such specific requirments.
ImageRepresents image DTO.
ImageCompressionVersionDescribes versions of image compression algorithm.
ImageEncodingImage encoding type.
ImageFooterRepresents Pdf image footer.
ImageFragmentRepresents Image Fragment DTO.
ImageHeaderRepresents Pdf image header.
ImageResponseRepresents response containing single image info
ImagesRepresents list of images.
ImageSrcTypeAllows to specify image file format.
ImagesResponseRepresents response containing multiple images info
ImageStampRepresents Pdf stamps.
ImageTemplateTemplate of image.
ImageTemplatesRequestCreate document from images request.
InkAnnotationProvides InkAnnotation.
InkAnnotationResponseRepresents response containing single ink annotation object
InkAnnotationsObject representing a list of ink annotations.
InkAnnotationsResponseRepresents response containing multiple ink annotation objects
JustificationEnumerates the forms of quadding (justification) to be used in displaying the annotation’s text.
LettersPositioningMethodsIt enumerates possible modes of positioning of letters in words in result HTML
LineAnnotationProvides LineAnnotation.
LineAnnotationResponseRepresents response containing single line annotation object
LineAnnotationsObject representing a list of line annotations.
LineAnnotationsResponseRepresents response containing multiple line annotation objects
LineEndingEnumerates the line ending styles to be used in drawing the line.
LineIntentEnumerates the intents of the line annotation.
LineSpacingDefines line spacing specifics
LinkProvides information for the object link. This is supposed to be an atom:link, therefore it should have all attributes specified here http://tools.ietf.org/html/rfc4287#section-4.2.7
LinkActionTypeRepresents list of link action types.
LinkAnnotationProvides link to linkAnnotation.
LinkAnnotationResponseRepresents response containing single link info
LinkAnnotationsObject representing a list of link annotations.
LinkAnnotationsResponseRepresents response containing multiple links info
LinkElementRepresents base DTO object.
LinkHighlightingModeEnumerates the annotation’s highlighting mode, the visual effect to be used when the mouse button is pressed or held down inside its active area.
ListBoxFieldProvides ListBoxField.
ListBoxFieldResponseRepresents response containing single listbox field object
ListBoxFieldsObject representing a list of listbox fields.
ListBoxFieldsResponseRepresents response containing multiple listbox field objects
MarginInfoThis class represents a margin for different objects.
MarkupAnnotationProvides MarkupAnnotation.
MergeDocumentsDocuments for merging.
MovieAnnotationProvides MovieAnnotation.
MovieAnnotationResponseRepresents response containing single movie annotation object
MovieAnnotationsObject representing a list of movie annotations.
MovieAnnotationsResponseRepresents response containing multiple movie annotation objects
ObjectExistObject exists
OptimizeOptionsRepresents Pdf optimize options.
OptionProvides form option.
OutputFormatEnumeration for output type format.
PageProvides link to page.
PageLayoutDescibes page layout.
PageModeClass descibes used components of the document page.
PageNumberStampRepresents Pdf stamps.
PagesRepresents list of pages.
PageWordCountPage words count.
ParagraphRepresents text paragraphs as multiline text object.
PartsEmbeddingModesThis enum enumerates possible modes of embedding of files referenced in HTML It allows to control whether referenced files (HTML, Fonts,Images, CSSes) will be embedded into main HTML file or will be generated as apart binary entities
PdfATypeAllows to specify PdfA file format.
PdfPageStampRepresents Pdf stamps.
PermissionsFlagsThis enum represents user's permissions for a pdf.
PointRepresent point with fractional coordinates.
PolyAnnotationProvides PolyAnnotation.
PolygonAnnotationProvides PolygonAnnotation.
PolygonAnnotationResponseRepresents response containing single polygon annotation object
PolygonAnnotationsObject representing a list of polygon annotations.
PolygonAnnotationsResponseRepresents response containing multiple polygon annotation objects
PolyIntentEnumerates the intents of the polygon or polyline annotation.
PolyLineAnnotationProvides PolyLineAnnotation.
PolyLineAnnotationResponseRepresents response containing single polyline annotation object
PolyLineAnnotationsObject representing a list of polyline annotations.
PolyLineAnnotationsResponseRepresents response containing multiple polyline annotation objects
PopupAnnotationProvides PopupAnnotation.
PopupAnnotationResponseRepresents response containing single popup annotation object
PopupAnnotationsObject representing a list of popup annotations.
PopupAnnotationsResponseRepresents response containing multiple popup annotation objects
PopupAnnotationWithParentProvides PopupAnnotation.
PositionRepresents a position object
RadioButtonFieldProvides RadioButtonField.
RadioButtonFieldResponseRepresents response containing single RadioButton field object
RadioButtonFieldsObject representing a list of radiobox fields.
RadioButtonFieldsResponseRepresents response containing multiple RadioButton field objects
RadioButtonOptionFieldProvides RadioButtonField.
RasterImagesSavingModesConverted PDF can contain raster images(.png, *.jpeg etc.) This enum defines methods of how raster images can be handled during conversion of PDF to HTML
RectangleRepresents rectangle DTO.
RedactionAnnotationProvides RedactionAnnotation.
RedactionAnnotationResponseRepresents response containing single redaction annotation object
RedactionAnnotationsObject representing a list of redaction annotations.
RedactionAnnotationsResponseRepresents response containing multiple redaction annotation objects
RotationEnumeration of possible rotation values.
RowRepresents a row of the table.
RowRecognized
ScreenAnnotationProvides ScreenAnnotation.
ScreenAnnotationResponseRepresents response containing single screen annotation object
ScreenAnnotationsObject representing a list of screen annotations.
ScreenAnnotationsResponseRepresents response containing multiple screen annotation objects
SegmentRepresents segment of Pdf text.
ShapeTypeThis enum represents shape type for the extracted images.
SignatureRepresents signature.
SignatureCustomAppearanceAn abstract class which represents signature custom appearance object.
SignatureFieldProvides SignatureField.
SignatureFieldResponseRepresents response containing single signature field object
SignatureFieldsObject representing a list of signature fields.
SignatureFieldsResponseRepresents response containing multiple signature field objects
SignatureTypeThe type of signature.
SignatureVerifyResponseRepresent responce containing signature verification result
SoundAnnotationProvides SoundAnnotation.
SoundAnnotationResponseRepresents response containing single Sound annotation object
SoundAnnotationsObject representing a list of Sound annotations.
SoundAnnotationsResponseRepresents response containing multiple sound annotation objects
SoundEncodingThe encoding format for the sample data.
SoundIconAn icon to be used in displaying the annotation.
SplitResultRepresents split result object.
SplitResultDocumentRepresents split result document,
SplitResultResponseRepresents responce containing split result.
SquareAnnotationProvides SquareAnnotation.
SquareAnnotationResponseRepresents response containing single square annotation object
SquareAnnotationsObject representing a list of square annotations.
SquareAnnotationsResponseRepresents response containing multiple square annotation objects
SquigglyAnnotationProvides SquigglyAnnotation.
SquigglyAnnotationResponseRepresents response containing single squiggly-underline annotation object
SquigglyAnnotationsObject representing a list of squiggly-underline annotations.
SquigglyAnnotationsResponseRepresents response containing multiple squiggly-underline annotation objects
StampRepresents Pdf stamps.
StampAnnotationProvides StampAnnotation.
StampAnnotationResponseRepresents response containing single stamp annotation object
StampAnnotationsObject representing a list of stamp annotations.
StampAnnotationsResponseRepresents response containing multiple stamp annotation objects
StampBaseRepresents Pdf stamps.
StampIconEnumerates the icons to be used in displaying the annotation.
StampInfoProvides stamp info.
StampsInfoObject representing a list of stamps.
StampsInfoResponseRepresents multiple stamps info reponse
StampTypeRepresents enumeration of the stamp types.
StorageExistStorage exists
StorageFileFile or folder information
StrikeOutAnnotationProvides StrikeOutAnnotation.
StrikeOutAnnotationResponseRepresents response containing single strikeout annotation object
StrikeOutAnnotationsObject representing a list of strikeout annotations.
StrikeOutAnnotationsResponseRepresents response containing multiple strikeout annotation objects
TableRepresents a table that can be added to the page.
TableBrokenEnumerates the table broken.
TableRecognized
TableRecognizedResponseRepresents response containing single recognized table
TablesRecognizedRepresents list of recognized tables.
TablesRecognizedResponseRepresents response containing multiple tables info
TextAnnotationProvides TextAnnotation.
TextAnnotationResponseRepresents response containing single text annotation object
TextAnnotationsObject representing a list of text annotations.
TextAnnotationsResponseRepresents response containing multiple text annotation objects
TextBoxFieldProvides TextBoxField.
TextBoxFieldResponseRepresents response containing single text box field object
TextBoxFieldsObject representing a list of text box fields.
TextBoxFieldsResponseRepresents response containing multiple text box field objects
TextFooterRepresents Pdf text header.
TextHeaderRepresents Pdf text header.
TextHorizontalAlignmentDescribes text horizontal alignment.
TextIconEnumerates the icons to be used in displaying the annotation.
TextLineA line of text to be inserted into paragraph.
TextRectRepresents text occurrence.
TextRectsRepresents multiple text occurrences DTO.
TextRectsResponseRepresents response containing multiple text occurrences info
TextReplaceSingle text replacement setting.
TextReplaceListRequestMultiple text replacements request.
TextReplaceResponseRepresents response containing the result of text replacement
TextStampRepresents Pdf stamps.
TextStateRepresents a text state of a text
TextStyleRepresents a text style of a text
TimestampSettingsRepresents the ocsp settings using during signing process.
UnderlineAnnotationProvides UnderlineAnnotation.
UnderlineAnnotationResponseRepresents response containing single underline annotation object
UnderlineAnnotationsObject representing a list of underline annotations.
UnderlineAnnotationsResponseRepresents response containing multiple underline annotation objects
VerticalAlignmentEnumeration of possible vertical alignment values.
WordCountNumber of words per document pages.
WordCountResponseNumber of words per document pages.
WrapModeDefines word wrapping strategies

Keywords

FAQs

Package last updated on 26 Apr 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc