Categorygithub.com/aspose-pdf-cloud/aspose-pdf-cloud-go/v22

# README

GitHub release (latest by date) GitHub license

Go SDK for Aspose.PDF Cloud REST API

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.

Enhancements in Version 22.12

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

Installation

    go get -u github.com/aspose-pdf-cloud/aspose-pdf-cloud-go/v22

Getting Started

Please follow the installation instruction and execute the following Go code:

Get PDF Page Circle Annotations in Go

        import asposepdfcloud "github.com/aspose-pdf-cloud/aspose-pdf-cloud-go/v22"

        ...

	// Get your ClientId and ClientSecret from https://dashboard.aspose.cloud (free registration required).
	pdfApi := asposepdfcloud.NewPdfApiService("MY_CLIENT_ID", "MY_CLIENT_SECRET", "")
	args := map[string]interface{} {
		"folder": "path/to/remote/folder",
	}
	return pdfApi.GetDocumentCircleAnnotations("PdfWithAnnotations.pdf", args)

Unit Tests

Aspose PDF Cloud 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 Cloud 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.
PdfApiGetDocumentPolyLineAnnotationsGet /pdf/{name}/annotations/polylineRead document polyline annotations.
PdfApiGetDocumentPolygonAnnotationsGet /pdf/{name}/annotations/polygonRead document polygon 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.
PdfApiGetFileVersionsGet /pdf/storage/version/{path}Get file versions
PdfApiGetFilesListGet /pdf/storage/folder/{path}Get all files and folders within a folder
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.
PdfApiGetPagePolyLineAnnotationsGet /pdf/{name}/pages/{pageNumber}/annotations/polylineRead document page polyline annotations.
PdfApiGetPagePolygonAnnotationsGet /pdf/{name}/pages/{pageNumber}/annotations/polygonRead document page polygon 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.
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.
PdfApiGetPagesGet /pdf/{name}/pagesRead document pages info.
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
PdfApiGetPolyLineAnnotationGet /pdf/{name}/annotations/polyline/{annotationId}Read document page polyline annotation by ID.
PdfApiGetPolygonAnnotationGet /pdf/{name}/annotations/polygon/{annotationId}Read document page polygon 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.
PdfApiPostPagePolyLineAnnotationsPost /pdf/{name}/pages/{pageNumber}/annotations/polylineAdd document page polyline annotations.
PdfApiPostPagePolygonAnnotationsPost /pdf/{name}/pages/{pageNumber}/annotations/polygonAdd document page polygon 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.
PdfApiPostSignDocumentPost /pdf/{name}/signSign document.
PdfApiPostSignPagePost /pdf/{name}/pages/{pageNumber}/signSign page.
PdfApiPostSignatureFieldPost /pdf/{name}/fields/signatureAdd document signature field.
PdfApiPostSplitDocumentPost /pdf/{name}/splitSplit document to parts.
PdfApiPostSplitRangePdfDocumentPost /pdf/{name}/splitrangepdfSplit document into ranges.
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
PdfApiPutPolyLineAnnotationPut /pdf/{name}/annotations/polyline/{annotationId}Replace document polyline annotation
PdfApiPutPolygonAnnotationPut /pdf/{name}/annotations/polygon/{annotationId}Replace document polygon 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