Skip to content
.NET library for communicating with the Aspose.Pdf for Cloud API
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Examples
docs
src
testData
.gitattributes
.gitignore
.swagger-codegen-ignore
Aspose.Pdf.Cloud.Sdk.Core.sln
Aspose.Pdf.Cloud.Sdk.sln
LICENSE
README.md
build.bat

README.md

Aspose.Pdf for Cloud

  • API version: 2.0
  • SDK version: 19.3.0

Aspose.Pdf for 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 for 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.

Currently Available SDKs

Currently available SDKs can be found here. To use theese SDKs, you will need App SID and App Key which can be looked up at Aspose Cloud Dashboard (free registration in Aspose Cloud is required for this).

Unit Tests

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

Licensing

All Aspose.Pdf for Cloud SDKs are licensed under MIT License.

Resources

Dependencies

The DLLs included in the package may not be the latest version. We recommend using [NuGet] (https://docs.nuget.org/consume/installing-nuget) to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742

Documentation for API Endpoints

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

Class Method HTTP request Description
PdfApi DeleteAnnotation DELETE /pdf/{name}/annotations/{annotationId} Delete document annotation by ID
PdfApi DeleteDocumentAnnotations DELETE /pdf/{name}/annotations Delete all annotations from the document
PdfApi DeleteDocumentLinkAnnotations DELETE /pdf/{name}/links Delete all link annotations from the document
PdfApi DeleteDocumentStamps DELETE /pdf/{name}/stamps Delete all stamps from the document
PdfApi DeleteDocumentTables DELETE /pdf/{name}/tables Delete all tables from the document
PdfApi DeleteField DELETE /pdf/{name}/fields/{fieldName} Delete document field by name.
PdfApi DeleteFile DELETE /storage/file Remove a specific file
PdfApi DeleteFolder DELETE /storage/folder Remove a specific folder
PdfApi DeleteImage DELETE /pdf/{name}/images/{imageId} Delete image from document page.
PdfApi DeleteLinkAnnotation DELETE /pdf/{name}/links/{linkId} Delete document page link annotation by ID
PdfApi DeletePage DELETE /pdf/{name}/pages/{pageNumber} Delete document page by its number.
PdfApi DeletePageAnnotations DELETE /pdf/{name}/pages/{pageNumber}/annotations Delete all annotations from the page
PdfApi DeletePageLinkAnnotations DELETE /pdf/{name}/pages/{pageNumber}/links Delete all link annotations from the page
PdfApi DeletePageStamps DELETE /pdf/{name}/pages/{pageNumber}/stamps Delete all stamps from the page
PdfApi DeletePageTables DELETE /pdf/{name}/pages/{pageNumber}/tables Delete all tables from the page
PdfApi DeleteProperties DELETE /pdf/{name}/documentproperties Delete custom document properties.
PdfApi DeleteProperty DELETE /pdf/{name}/documentproperties/{propertyName} Delete document property.
PdfApi DeleteStamp DELETE /pdf/{name}/stamps/{stampId} Delete document stamp by ID
PdfApi DeleteTable DELETE /pdf/{name}/tables/{tableId} Delete document table by ID
PdfApi GetCaretAnnotation GET /pdf/{name}/annotations/caret/{annotationId} Read document page caret annotation by ID.
PdfApi GetCircleAnnotation GET /pdf/{name}/annotations/circle/{annotationId} Read document page circle annotation by ID.
PdfApi GetDiscUsage GET /storage/disc Check the disk usage of the current account
PdfApi GetDocument GET /pdf/{name} Read common document info.
PdfApi GetDocumentAnnotations GET /pdf/{name}/annotations Read documant page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases.
PdfApi GetDocumentAttachmentByIndex GET /pdf/{name}/attachments/{attachmentIndex} Read document attachment info by its index.
PdfApi GetDocumentAttachments GET /pdf/{name}/attachments Read document attachments info.
PdfApi GetDocumentBookmarks GET /pdf/{name}/bookmarks Read document bookmark/bookmarks (including children).
PdfApi GetDocumentCaretAnnotations GET /pdf/{name}/annotations/caret Read document caret annotations.
PdfApi GetDocumentCircleAnnotations GET /pdf/{name}/annotations/circle Read document circle annotations.
PdfApi GetDocumentFileAttachmentAnnotations GET /pdf/{name}/annotations/fileattachment Read document FileAttachment annotations.
PdfApi GetDocumentFreeTextAnnotations GET /pdf/{name}/annotations/freetext Read document free text annotations.
PdfApi GetDocumentHighlightAnnotations GET /pdf/{name}/annotations/highlight Read document highlight annotations.
PdfApi GetDocumentInkAnnotations GET /pdf/{name}/annotations/ink Read document ink annotations.
PdfApi GetDocumentLineAnnotations GET /pdf/{name}/annotations/line Read document line annotations.
PdfApi GetDocumentMovieAnnotations GET /pdf/{name}/annotations/movie Read document movie annotations.
PdfApi GetDocumentPolyLineAnnotations GET /pdf/{name}/annotations/polyline Read document polyline annotations.
PdfApi GetDocumentPolygonAnnotations GET /pdf/{name}/annotations/polygon Read document polygon annotations.
PdfApi GetDocumentPopupAnnotations GET /pdf/{name}/annotations/popup Read document popup annotations.
PdfApi GetDocumentPopupAnnotationsByParent GET /pdf/{name}/annotations/{annotationId}/popup Read document popup annotations by parent id.
PdfApi GetDocumentProperties GET /pdf/{name}/documentproperties Read document properties.
PdfApi GetDocumentProperty GET /pdf/{name}/documentproperties/{propertyName} Read document property by name.
PdfApi GetDocumentRedactionAnnotations GET /pdf/{name}/annotations/redaction Read document redaction annotations.
PdfApi GetDocumentScreenAnnotations GET /pdf/{name}/annotations/screen Read document screen annotations.
PdfApi GetDocumentSoundAnnotations GET /pdf/{name}/annotations/sound Read document sound annotations.
PdfApi GetDocumentSquareAnnotations GET /pdf/{name}/annotations/square Read document square annotations.
PdfApi GetDocumentSquigglyAnnotations GET /pdf/{name}/annotations/squiggly Read document squiggly annotations.
PdfApi GetDocumentStampAnnotations GET /pdf/{name}/annotations/stamp Read document stamp annotations.
PdfApi GetDocumentStamps GET /pdf/{name}/stamps Read document stamps.
PdfApi GetDocumentStrikeOutAnnotations GET /pdf/{name}/annotations/strikeout Read document StrikeOut annotations.
PdfApi GetDocumentTables GET /pdf/{name}/tables Read document tables.
PdfApi GetDocumentTextAnnotations GET /pdf/{name}/annotations/text Read document text annotations.
PdfApi GetDocumentUnderlineAnnotations GET /pdf/{name}/annotations/underline Read document underline annotations.
PdfApi GetDownload GET /storage/file Download a specific file
PdfApi GetDownloadDocumentAttachmentByIndex GET /pdf/{name}/attachments/{attachmentIndex}/download Download document attachment content by its index.
PdfApi GetEpubInStorageToPdf GET /pdf/create/epub Convert EPUB file (located on storage) to PDF format and return resulting file in response.
PdfApi GetField GET /pdf/{name}/fields/{fieldName} Get document field by name.
PdfApi GetFields GET /pdf/{name}/fields Get document fields.
PdfApi GetFileAttachmentAnnotation GET /pdf/{name}/annotations/fileattachment/{annotationId} Read document page FileAttachment annotation by ID.
PdfApi GetFileAttachmentAnnotationData GET /pdf/{name}/annotations/fileattachment/{annotationId}/data Read document page FileAttachment annotation by ID.
PdfApi GetFreeTextAnnotation GET /pdf/{name}/annotations/freetext/{annotationId} Read document page free text annotation by ID.
PdfApi GetHighlightAnnotation GET /pdf/{name}/annotations/highlight/{annotationId} Read document page highlight annotation by ID.
PdfApi GetHtmlInStorageToPdf GET /pdf/create/html Convert HTML file (located on storage) to PDF format and return resulting file in response.
PdfApi GetImage GET /pdf/{name}/images/{imageId} Read document image by ID.
PdfApi GetImageExtractAsGif GET /pdf/{name}/images/{imageId}/extract/gif Extract document image in GIF format
PdfApi GetImageExtractAsJpeg GET /pdf/{name}/images/{imageId}/extract/jpeg Extract document image in JPEG format
PdfApi GetImageExtractAsPng GET /pdf/{name}/images/{imageId}/extract/png Extract document image in PNG format
PdfApi GetImageExtractAsTiff GET /pdf/{name}/images/{imageId}/extract/tiff Extract document image in TIFF format
PdfApi GetImages GET /pdf/{name}/pages/{pageNumber}/images Read document images.
PdfApi GetInkAnnotation GET /pdf/{name}/annotations/ink/{annotationId} Read document page ink annotation by ID.
PdfApi GetIsExist GET /storage/exist Check if a specific file or folder exists
PdfApi GetIsStorageExist GET /storage/{name}/exist Check if storage exists
PdfApi GetLaTeXInStorageToPdf GET /pdf/create/latex Convert LaTeX file (located on storage) to PDF format and return resulting file in response.
PdfApi GetLineAnnotation GET /pdf/{name}/annotations/line/{annotationId} Read document page line annotation by ID.
PdfApi GetLinkAnnotation GET /pdf/{name}/links/{linkId} Read document link annotation by ID.
PdfApi GetListFileVersions GET /storage/version Get the file's versions list
PdfApi GetListFiles GET /storage/folder Get the file listing of a specific folder
PdfApi GetMhtInStorageToPdf GET /pdf/create/mht Convert MHT file (located on storage) to PDF format and return resulting file in response.
PdfApi GetMovieAnnotation GET /pdf/{name}/annotations/movie/{annotationId} Read document page movie annotation by ID.
PdfApi GetPage GET /pdf/{name}/pages/{pageNumber} Read document page info.
PdfApi GetPageAnnotations GET /pdf/{name}/pages/{pageNumber}/annotations Read document page annotations. Returns only FreeTextAnnotations, TextAnnotations, other annotations will implemented next releases.
PdfApi GetPageCaretAnnotations GET /pdf/{name}/pages/{pageNumber}/annotations/caret Read document page caret annotations.
PdfApi GetPageCircleAnnotations GET /pdf/{name}/pages/{pageNumber}/annotations/circle Read document page circle annotations.
PdfApi GetPageConvertToBmp GET /pdf/{name}/pages/{pageNumber}/convert/bmp Convert document page to Bmp image and return resulting file in response.
PdfApi GetPageConvertToEmf GET /pdf/{name}/pages/{pageNumber}/convert/emf Convert document page to Emf image and return resulting file in response.
PdfApi GetPageConvertToGif GET /pdf/{name}/pages/{pageNumber}/convert/gif Convert document page to Gif image and return resulting file in response.
PdfApi GetPageConvertToJpeg GET /pdf/{name}/pages/{pageNumber}/convert/jpeg Convert document page to Jpeg image and return resulting file in response.
PdfApi GetPageConvertToPng GET /pdf/{name}/pages/{pageNumber}/convert/png Convert document page to Png image and return resulting file in response.
PdfApi GetPageConvertToTiff GET /pdf/{name}/pages/{pageNumber}/convert/tiff Convert document page to Tiff image and return resulting file in response.
PdfApi GetPageFileAttachmentAnnotations GET /pdf/{name}/pages/{pageNumber}/annotations/fileattachment Read document page FileAttachment annotations.
PdfApi GetPageFreeTextAnnotations GET /pdf/{name}/pages/{pageNumber}/annotations/freetext Read document page free text annotations.
PdfApi GetPageHighlightAnnotations GET /pdf/{name}/pages/{pageNumber}/annotations/highlight Read document page highlight annotations.
PdfApi GetPageInkAnnotations GET /pdf/{name}/pages/{pageNumber}/annotations/ink Read document page ink annotations.
PdfApi GetPageLineAnnotations GET /pdf/{name}/pages/{pageNumber}/annotations/line Read document page line annotations.
PdfApi GetPageLinkAnnotation GET /pdf/{name}/pages/{pageNumber}/links/{linkId} Read document page link annotation by ID.
PdfApi GetPageLinkAnnotations GET /pdf/{name}/pages/{pageNumber}/links Read document page link annotations.
PdfApi GetPageMovieAnnotations GET /pdf/{name}/pages/{pageNumber}/annotations/movie Read document page movie annotations.
PdfApi GetPagePolyLineAnnotations GET /pdf/{name}/pages/{pageNumber}/annotations/polyline Read document page polyline annotations.
PdfApi GetPagePolygonAnnotations GET /pdf/{name}/pages/{pageNumber}/annotations/polygon Read document page polygon annotations.
PdfApi GetPagePopupAnnotations GET /pdf/{name}/pages/{pageNumber}/annotations/popup Read document page popup annotations.
PdfApi GetPageRedactionAnnotations GET /pdf/{name}/pages/{pageNumber}/annotations/redaction Read document page redaction annotations.
PdfApi GetPageScreenAnnotations GET /pdf/{name}/pages/{pageNumber}/annotations/screen Read document page screen annotations.
PdfApi GetPageSoundAnnotations GET /pdf/{name}/pages/{pageNumber}/annotations/sound Read document page sound annotations.
PdfApi GetPageSquareAnnotations GET /pdf/{name}/pages/{pageNumber}/annotations/square Read document page square annotations.
PdfApi GetPageSquigglyAnnotations GET /pdf/{name}/pages/{pageNumber}/annotations/squiggly Read document page squiggly annotations.
PdfApi GetPageStampAnnotations GET /pdf/{name}/pages/{pageNumber}/annotations/stamp Read document page stamp annotations.
PdfApi GetPageStamps GET /pdf/{name}/pages/{pageNumber}/stamps Read page document stamps.
PdfApi GetPageStrikeOutAnnotations GET /pdf/{name}/pages/{pageNumber}/annotations/strikeout Read document page StrikeOut annotations.
PdfApi GetPageTables GET /pdf/{name}/pages/{pageNumber}/tables Read document page tables.
PdfApi GetPageText GET /pdf/{name}/pages/{pageNumber}/text Read page text items.
PdfApi GetPageTextAnnotations GET /pdf/{name}/pages/{pageNumber}/annotations/text Read document page text annotations.
PdfApi GetPageUnderlineAnnotations GET /pdf/{name}/pages/{pageNumber}/annotations/underline Read document page underline annotations.
PdfApi GetPages GET /pdf/{name}/pages Read document pages info.
PdfApi GetPclInStorageToPdf GET /pdf/create/pcl Convert PCL file (located on storage) to PDF format and return resulting file in response.
PdfApi GetPdfInStorageToDoc GET /pdf/{name}/convert/doc Converts PDF document (located on storage) to DOC format and returns resulting file in response content
PdfApi GetPdfInStorageToEpub GET /pdf/{name}/convert/epub Converts PDF document (located on storage) to EPUB format and returns resulting file in response content
PdfApi GetPdfInStorageToHtml GET /pdf/{name}/convert/html Converts PDF document (located on storage) to Html format and returns resulting file in response content
PdfApi GetPdfInStorageToLaTeX GET /pdf/{name}/convert/latex Converts PDF document (located on storage) to LaTeX format and returns resulting file in response content
PdfApi GetPdfInStorageToMobiXml GET /pdf/{name}/convert/mobixml Converts PDF document (located on storage) to MOBIXML format and returns resulting file in response content
PdfApi GetPdfInStorageToPdfA GET /pdf/{name}/convert/pdfa Converts PDF document (located on storage) to PdfA format and returns resulting file in response content
PdfApi GetPdfInStorageToPptx GET /pdf/{name}/convert/pptx Converts PDF document (located on storage) to PPTX format and returns resulting file in response content
PdfApi GetPdfInStorageToSvg GET /pdf/{name}/convert/svg Converts PDF document (located on storage) to SVG format and returns resulting file in response content
PdfApi GetPdfInStorageToTiff GET /pdf/{name}/convert/tiff Converts PDF document (located on storage) to TIFF format and returns resulting file in response content
PdfApi GetPdfInStorageToXls GET /pdf/{name}/convert/xls Converts PDF document (located on storage) to XLS format and returns resulting file in response content
PdfApi GetPdfInStorageToXml GET /pdf/{name}/convert/xml Converts PDF document (located on storage) to XML format and returns resulting file in response content
PdfApi GetPdfInStorageToXps GET /pdf/{name}/convert/xps Converts PDF document (located on storage) to XPS format and returns resulting file in response content
PdfApi GetPolyLineAnnotation GET /pdf/{name}/annotations/polyline/{annotationId} Read document page polyline annotation by ID.
PdfApi GetPolygonAnnotation GET /pdf/{name}/annotations/polygon/{annotationId} Read document page polygon annotation by ID.
PdfApi GetPopupAnnotation GET /pdf/{name}/annotations/popup/{annotationId} Read document page popup annotation by ID.
PdfApi GetPsInStorageToPdf GET /pdf/create/ps Convert PS file (located on storage) to PDF format and return resulting file in response.
PdfApi GetRedactionAnnotation GET /pdf/{name}/annotations/redaction/{annotationId} Read document page redaction annotation by ID.
PdfApi GetScreenAnnotation GET /pdf/{name}/annotations/screen/{annotationId} Read document page screen annotation by ID.
PdfApi GetScreenAnnotationData GET /pdf/{name}/annotations/screen/{annotationId}/data Read document page screen annotation by ID.
PdfApi GetSoundAnnotation GET /pdf/{name}/annotations/sound/{annotationId} Read document page sound annotation by ID.
PdfApi GetSoundAnnotationData GET /pdf/{name}/annotations/sound/{annotationId}/data Read document page sound annotation by ID.
PdfApi GetSquareAnnotation GET /pdf/{name}/annotations/square/{annotationId} Read document page square annotation by ID.
PdfApi GetSquigglyAnnotation GET /pdf/{name}/annotations/squiggly/{annotationId} Read document page squiggly annotation by ID.
PdfApi GetStampAnnotation GET /pdf/{name}/annotations/stamp/{annotationId} Read document page stamp annotation by ID.
PdfApi GetStampAnnotationData GET /pdf/{name}/annotations/stamp/{annotationId}/data Read document page stamp annotation by ID.
PdfApi GetStrikeOutAnnotation GET /pdf/{name}/annotations/strikeout/{annotationId} Read document page StrikeOut annotation by ID.
PdfApi GetSvgInStorageToPdf GET /pdf/create/svg Convert SVG file (located on storage) to PDF format and return resulting file in response.
PdfApi GetTable GET /pdf/{name}/tables/{tableId} Read document page table by ID.
PdfApi GetText GET /pdf/{name}/text Read document text.
PdfApi GetTextAnnotation GET /pdf/{name}/annotations/text/{annotationId} Read document page text annotation by ID.
PdfApi GetUnderlineAnnotation GET /pdf/{name}/annotations/underline/{annotationId} Read document page underline annotation by ID.
PdfApi GetVerifySignature GET /pdf/{name}/verifySignature Verify signature document.
PdfApi GetWebInStorageToPdf GET /pdf/create/web Convert web page to PDF format and return resulting file in response.
PdfApi GetWordsPerPage GET /pdf/{name}/pages/wordCount Get number of words per document page.
PdfApi GetXfaPdfInStorageToAcroForm GET /pdf/{name}/convert/xfatoacroform Converts PDF document which contatins XFA form (located on storage) to PDF with AcroForm and returns resulting file response content
PdfApi GetXmlInStorageToPdf GET /pdf/create/xml Convert XML file (located on storage) to PDF format and return resulting file in response.
PdfApi GetXpsInStorageToPdf GET /pdf/create/xps Convert XPS file (located on storage) to PDF format and return resulting file in response.
PdfApi GetXslFoInStorageToPdf GET /pdf/create/xslfo Convert XslFo file (located on storage) to PDF format and return resulting file in response.
PdfApi PostAppendDocument POST /pdf/{name}/appendDocument Append document to existing one.
PdfApi PostCreateField POST /pdf/{name}/fields Create field.
PdfApi PostDocumentTextReplace POST /pdf/{name}/text/replace Document's replace text method.
PdfApi PostFlattenDocument POST /pdf/{name}/flatten Flatten the document.
PdfApi PostInsertImage POST /pdf/{name}/pages/{pageNumber}/images Insert image to document page.
PdfApi PostMoveFile POST /storage/file Move a specific file
PdfApi PostMoveFolder POST /storage/folder Move a specific folder
PdfApi PostMovePage POST /pdf/{name}/pages/{pageNumber}/movePage Move page to new position.
PdfApi PostOptimizeDocument POST /pdf/{name}/optimize Optimize document.
PdfApi PostPageCaretAnnotations POST /pdf/{name}/pages/{pageNumber}/annotations/caret Add document page caret annotations.
PdfApi PostPageCircleAnnotations POST /pdf/{name}/pages/{pageNumber}/annotations/circle Add document page circle annotations.
PdfApi PostPageFileAttachmentAnnotations POST /pdf/{name}/pages/{pageNumber}/annotations/fileattachment Add document page FileAttachment annotations.
PdfApi PostPageFreeTextAnnotations POST /pdf/{name}/pages/{pageNumber}/annotations/freetext Add document page free text annotations.
PdfApi PostPageHighlightAnnotations POST /pdf/{name}/pages/{pageNumber}/annotations/highlight Add document page highlight annotations.
PdfApi PostPageImageStamps POST /pdf/{name}/pages/{pageNumber}/stamps/image Add document page image stamps.
PdfApi PostPageInkAnnotations POST /pdf/{name}/pages/{pageNumber}/annotations/ink Add document page ink annotations.
PdfApi PostPageLineAnnotations POST /pdf/{name}/pages/{pageNumber}/annotations/line Add document page line annotations.
PdfApi PostPageLinkAnnotations POST /pdf/{name}/pages/{pageNumber}/links Add document page link annotations.
PdfApi PostPageMovieAnnotations POST /pdf/{name}/pages/{pageNumber}/annotations/movie Add document page movie annotations.
PdfApi PostPagePdfPageStamps POST /pdf/{name}/pages/{pageNumber}/stamps/pdfpage Add document pdf page stamps.
PdfApi PostPagePolyLineAnnotations POST /pdf/{name}/pages/{pageNumber}/annotations/polyline Add document page polyline annotations.
PdfApi PostPagePolygonAnnotations POST /pdf/{name}/pages/{pageNumber}/annotations/polygon Add document page polygon annotations.
PdfApi PostPageRedactionAnnotations POST /pdf/{name}/pages/{pageNumber}/annotations/redaction Add document page redaction annotations.
PdfApi PostPageScreenAnnotations POST /pdf/{name}/pages/{pageNumber}/annotations/screen Add document page screen annotations.
PdfApi PostPageSoundAnnotations POST /pdf/{name}/pages/{pageNumber}/annotations/sound Add document page sound annotations.
PdfApi PostPageSquareAnnotations POST /pdf/{name}/pages/{pageNumber}/annotations/square Add document page square annotations.
PdfApi PostPageSquigglyAnnotations POST /pdf/{name}/pages/{pageNumber}/annotations/squiggly Add document page squiggly annotations.
PdfApi PostPageStampAnnotations POST /pdf/{name}/pages/{pageNumber}/annotations/stamp Add document page stamp annotations.
PdfApi PostPageStrikeOutAnnotations POST /pdf/{name}/pages/{pageNumber}/annotations/strikeout Add document page StrikeOut annotations.
PdfApi PostPageTextAnnotations POST /pdf/{name}/pages/{pageNumber}/annotations/text Add document page text annotations.
PdfApi PostPageTextReplace POST /pdf/{name}/pages/{pageNumber}/text/replace Page's replace text method.
PdfApi PostPageTextStamps POST /pdf/{name}/pages/{pageNumber}/stamps/text Add document page text stamps.
PdfApi PostPageUnderlineAnnotations POST /pdf/{name}/pages/{pageNumber}/annotations/underline Add document page underline annotations.
PdfApi PostPopupAnnotation POST /pdf/{name}/annotations/{annotationId}/popup Add document popup annotations.
PdfApi PostSignDocument POST /pdf/{name}/sign Sign document.
PdfApi PostSignPage POST /pdf/{name}/pages/{pageNumber}/sign Sign page.
PdfApi PostSplitDocument POST /pdf/{name}/split Split document to parts.
PdfApi PutAddNewPage PUT /pdf/{name}/pages Add new page to end of the document.
PdfApi PutAddText PUT /pdf/{name}/pages/{pageNumber}/text Add text to PDF document page.
PdfApi PutAnnotationsFlatten PUT /pdf/{name}/annotations/flatten Flattens the annotations of the specified types
PdfApi PutCaretAnnotation PUT /pdf/{name}/annotations/caret/{annotationId} Replace document caret annotation
PdfApi PutCircleAnnotation PUT /pdf/{name}/annotations/circle/{annotationId} Replace document circle annotation
PdfApi PutCreate PUT /storage/file Upload a specific file
PdfApi PutCreateDocument PUT /pdf/{name} Create empty document.
PdfApi PutCreateFolder PUT /storage/folder Create the folder
PdfApi PutEpubInStorageToPdf PUT /pdf/{name}/create/epub Convert EPUB file (located on storage) to PDF format and upload resulting file to storage.
PdfApi PutFieldsFlatten PUT /pdf/{name}/fields/flatten Flatten form fields in document.
PdfApi PutFileAttachmentAnnotation PUT /pdf/{name}/annotations/fileattachment/{annotationId} Replace document FileAttachment annotation
PdfApi PutFileAttachmentAnnotationDataExtract PUT /pdf/{name}/annotations/fileattachment/{annotationId}/data/extract Extract document FileAttachment annotation content to storage
PdfApi PutFreeTextAnnotation PUT /pdf/{name}/annotations/freetext/{annotationId} Replace document free text annotation
PdfApi PutHighlightAnnotation PUT /pdf/{name}/annotations/highlight/{annotationId} Replace document highlight annotation
PdfApi PutHtmlInStorageToPdf PUT /pdf/{name}/create/html Convert HTML file (located on storage) to PDF format and upload resulting file to storage.
PdfApi PutImageExtractAsGif PUT /pdf/{name}/images/{imageId}/extract/gif Extract document image in GIF format to folder
PdfApi PutImageExtractAsJpeg PUT /pdf/{name}/images/{imageId}/extract/jpeg Extract document image in JPEG format to folder
PdfApi PutImageExtractAsPng PUT /pdf/{name}/images/{imageId}/extract/png Extract document image in PNG format to folder
PdfApi PutImageExtractAsTiff PUT /pdf/{name}/images/{imageId}/extract/tiff Extract document image in TIFF format to folder
PdfApi PutImageInStorageToPdf PUT /pdf/{name}/create/images Convert image file (located on storage) to PDF format and upload resulting file to storage.
PdfApi PutImagesExtractAsGif PUT /pdf/{name}/pages/{pageNumber}/images/extract/gif Extract document images in GIF format to folder.
PdfApi PutImagesExtractAsJpeg PUT /pdf/{name}/pages/{pageNumber}/images/extract/jpeg Extract document images in JPEG format to folder.
PdfApi PutImagesExtractAsPng PUT /pdf/{name}/pages/{pageNumber}/images/extract/png Extract document images in PNG format to folder.
PdfApi PutImagesExtractAsTiff PUT /pdf/{name}/pages/{pageNumber}/images/extract/tiff Extract document images in TIFF format to folder.
PdfApi PutInkAnnotation PUT /pdf/{name}/annotations/ink/{annotationId} Replace document ink annotation
PdfApi PutLaTeXInStorageToPdf PUT /pdf/{name}/create/latex Convert LaTeX file (located on storage) to PDF format and upload resulting file to storage.
PdfApi PutLineAnnotation PUT /pdf/{name}/annotations/line/{annotationId} Replace document line annotation
PdfApi PutLinkAnnotation PUT /pdf/{name}/links/{linkId} Replace document page link annotations
PdfApi PutMergeDocuments PUT /pdf/{name}/merge Merge a list of documents.
PdfApi PutMhtInStorageToPdf PUT /pdf/{name}/create/mht Convert MHT file (located on storage) to PDF format and upload resulting file to storage.
PdfApi PutMovieAnnotation PUT /pdf/{name}/annotations/movie/{annotationId} Replace document movie annotation
PdfApi PutPageAddStamp PUT /pdf/{name}/pages/{pageNumber}/stamp Add page stamp.
PdfApi PutPageConvertToBmp PUT /pdf/{name}/pages/{pageNumber}/convert/bmp Convert document page to bmp image and upload resulting file to storage.
PdfApi PutPageConvertToEmf PUT /pdf/{name}/pages/{pageNumber}/convert/emf Convert document page to emf image and upload resulting file to storage.
PdfApi PutPageConvertToGif PUT /pdf/{name}/pages/{pageNumber}/convert/gif Convert document page to gif image and upload resulting file to storage.
PdfApi PutPageConvertToJpeg PUT /pdf/{name}/pages/{pageNumber}/convert/jpeg Convert document page to Jpeg image and upload resulting file to storage.
PdfApi PutPageConvertToPng PUT /pdf/{name}/pages/{pageNumber}/convert/png Convert document page to png image and upload resulting file to storage.
PdfApi PutPageConvertToTiff PUT /pdf/{name}/pages/{pageNumber}/convert/tiff Convert document page to Tiff image and upload resulting file to storage.
PdfApi PutPclInStorageToPdf PUT /pdf/{name}/create/pcl Convert PCL file (located on storage) to PDF format and upload resulting file to storage.
PdfApi PutPdfInRequestToDoc PUT /pdf/convert/doc Converts PDF document (in request content) to DOC format and uploads resulting file to storage.
PdfApi PutPdfInRequestToEpub PUT /pdf/convert/epub Converts PDF document (in request content) to EPUB format and uploads resulting file to storage.
PdfApi PutPdfInRequestToHtml PUT /pdf/convert/html Converts PDF document (in request content) to Html format and uploads resulting file to storage.
PdfApi PutPdfInRequestToLaTeX PUT /pdf/convert/latex Converts PDF document (in request content) to LaTeX format and uploads resulting file to storage.
PdfApi PutPdfInRequestToMobiXml PUT /pdf/convert/mobixml Converts PDF document (in request content) to MOBIXML format and uploads resulting file to storage.
PdfApi PutPdfInRequestToPdfA PUT /pdf/convert/pdfa Converts PDF document (in request content) to PdfA format and uploads resulting file to storage.
PdfApi PutPdfInRequestToPptx PUT /pdf/convert/pptx Converts PDF document (in request content) to PPTX format and uploads resulting file to storage.
PdfApi PutPdfInRequestToSvg PUT /pdf/convert/svg Converts PDF document (in request content) to SVG format and uploads resulting file to storage.
PdfApi PutPdfInRequestToTiff PUT /pdf/convert/tiff Converts PDF document (in request content) to TIFF format and uploads resulting file to storage.
PdfApi PutPdfInRequestToXls PUT /pdf/convert/xls Converts PDF document (in request content) to XLS format and uploads resulting file to storage.
PdfApi PutPdfInRequestToXml PUT /pdf/convert/xml Converts PDF document (in request content) to XML format and uploads resulting file to storage.
PdfApi PutPdfInRequestToXps PUT /pdf/convert/xps Converts PDF document (in request content) to XPS format and uploads resulting file to storage.
PdfApi PutPdfInStorageToDoc PUT /pdf/{name}/convert/doc Converts PDF document (located on storage) to DOC format and uploads resulting file to storage
PdfApi PutPdfInStorageToEpub PUT /pdf/{name}/convert/epub Converts PDF document (located on storage) to EPUB format and uploads resulting file to storage
PdfApi PutPdfInStorageToHtml PUT /pdf/{name}/convert/html Converts PDF document (located on storage) to Html format and uploads resulting file to storage
PdfApi PutPdfInStorageToLaTeX PUT /pdf/{name}/convert/latex Converts PDF document (located on storage) to LaTeX format and uploads resulting file to storage
PdfApi PutPdfInStorageToMobiXml PUT /pdf/{name}/convert/mobixml Converts PDF document (located on storage) to MOBIXML format and uploads resulting file to storage
PdfApi PutPdfInStorageToPdfA PUT /pdf/{name}/convert/pdfa Converts PDF document (located on storage) to PdfA format and uploads resulting file to storage
PdfApi PutPdfInStorageToPptx PUT /pdf/{name}/convert/pptx Converts PDF document (located on storage) to PPTX format and uploads resulting file to storage
PdfApi PutPdfInStorageToSvg PUT /pdf/{name}/convert/svg Converts PDF document (located on storage) to SVG format and uploads resulting file to storage
PdfApi PutPdfInStorageToTiff PUT /pdf/{name}/convert/tiff Converts PDF document (located on storage) to TIFF format and uploads resulting file to storage
PdfApi PutPdfInStorageToXls PUT /pdf/{name}/convert/xls Converts PDF document (located on storage) to XLS format and uploads resulting file to storage
PdfApi PutPdfInStorageToXml PUT /pdf/{name}/convert/xml Converts PDF document (located on storage) to XML format and uploads resulting file to storage
PdfApi PutPdfInStorageToXps PUT /pdf/{name}/convert/xps Converts PDF document (located on storage) to XPS format and uploads resulting file to storage
PdfApi PutPolyLineAnnotation PUT /pdf/{name}/annotations/polyline/{annotationId} Replace document polyline annotation
PdfApi PutPolygonAnnotation PUT /pdf/{name}/annotations/polygon/{annotationId} Replace document polygon annotation
PdfApi PutPopupAnnotation PUT /pdf/{name}/annotations/popup/{annotationId} Replace document popup annotation
PdfApi PutPrivileges PUT /pdf/{name}/privileges Update privilege document.
PdfApi PutPsInStorageToPdf PUT /pdf/{name}/create/ps Convert PS file (located on storage) to PDF format and upload resulting file to storage.
PdfApi PutRedactionAnnotation PUT /pdf/{name}/annotations/redaction/{annotationId} Replace document redaction annotation
PdfApi PutReplaceImage PUT /pdf/{name}/images/{imageId} Replace document image.
PdfApi PutScreenAnnotation PUT /pdf/{name}/annotations/screen/{annotationId} Replace document screen annotation
PdfApi PutScreenAnnotationDataExtract PUT /pdf/{name}/annotations/screen/{annotationId}/data/extract Extract document screen annotation content to storage
PdfApi PutSearchableDocument PUT /pdf/{name}/ocr Create searchable PDF document. Generate OCR layer for images in input PDF document.
PdfApi PutSetProperty PUT /pdf/{name}/documentproperties/{propertyName} Add/update document property.
PdfApi PutSoundAnnotation PUT /pdf/{name}/annotations/sound/{annotationId} Replace document sound annotation
PdfApi PutSoundAnnotationDataExtract PUT /pdf/{name}/annotations/sound/{annotationId}/data/extract Extract document sound annotation content to storage
PdfApi PutSquareAnnotation PUT /pdf/{name}/annotations/square/{annotationId} Replace document square annotation
PdfApi PutSquigglyAnnotation PUT /pdf/{name}/annotations/squiggly/{annotationId} Replace document squiggly annotation
PdfApi PutStampAnnotation PUT /pdf/{name}/annotations/stamp/{annotationId} Replace document stamp annotation
PdfApi PutStampAnnotationDataExtract PUT /pdf/{name}/annotations/stamp/{annotationId}/data/extract Extract document stamp annotation content to storage
PdfApi PutStrikeOutAnnotation PUT /pdf/{name}/annotations/strikeout/{annotationId} Replace document StrikeOut annotation
PdfApi PutSvgInStorageToPdf PUT /pdf/{name}/create/svg Convert SVG file (located on storage) to PDF format and upload resulting file to storage.
PdfApi PutTextAnnotation PUT /pdf/{name}/annotations/text/{annotationId} Replace document text annotation
PdfApi PutUnderlineAnnotation PUT /pdf/{name}/annotations/underline/{annotationId} Replace document underline annotation
PdfApi PutUpdateField PUT /pdf/{name}/fields/{fieldName} Update field.
PdfApi PutUpdateFields PUT /pdf/{name}/fields Update fields.
PdfApi PutWebInStorageToPdf PUT /pdf/{name}/create/web Convert web page to PDF format and upload resulting file to storage.
PdfApi PutXfaPdfInRequestToAcroForm PUT /pdf/convert/xfatoacroform Converts PDF document which contatins XFA form (in request content) to PDF with AcroForm and uploads resulting file to storage.
PdfApi PutXfaPdfInStorageToAcroForm PUT /pdf/{name}/convert/xfatoacroform Converts PDF document which contatins XFA form (located on storage) to PDF with AcroForm and uploads resulting file to storage
PdfApi PutXmlInStorageToPdf PUT /pdf/{name}/create/xml Convert XML file (located on storage) to PDF format and upload resulting file to storage.
PdfApi PutXpsInStorageToPdf PUT /pdf/{name}/create/xps Convert XPS file (located on storage) to PDF format and upload resulting file to storage.
PdfApi PutXslFoInStorageToPdf PUT /pdf/{name}/create/xslfo Convert XslFo file (located on storage) to PDF format and upload resulting file to storage.

Documentation for Models

You can’t perform that action at this time.