theme
Aspose.PDF Cloud
FREEMIUM
By asposecloud
Updated 4 months ago

Aspose.PDF Cloud API Documentation

Aspose.PDF Cloud APIs allows you to create, edit and convert PDF files in the cloud. You can convert PDF documents into various other formats like HTML, DOC, JPEG, TIFF, TXT etc. You can also extract PDF contents including text and images from the PDF files.

Learn more about this API
POSTPostDecryptDocumentInStorage
PUTPutPdfInStorageToXlsx
DELETEDeleteField
PUTPutSvgInStorageToPdf
POSTPostRadioButtonFields
PUTPutPdfInRequestToXls
GETGetPageCircleAnnotations
DELETEDeletePageAnnotations
GETGetXmlInStorageToPdf
GETGetPsInStorageToPdf
PUTPutPdfInStorageToEpub
PUTPutImagesExtractAsTiff
GETGetDocumentAnnotations
PUTPutPdfInStorageToXml
PUTPutPdfInStorageToSvg
POSTPostPagePolygonAnnotations
DELETEDeleteProperty
PUTPutExportFieldsFromPdfToFdfInStorage
GETGetEpubInStorageToPdf
GETGetPdfInStorageToEpub
GETGetHtmlInStorageToPdf
GETGetSvgInStorageToPdf
PUTPutWebInStorageToPdf
POSTPostPageSoundAnnotations
GETGetPageCheckBoxFields
GETGetPageSoundAnnotations
PUTPutPopupAnnotation
PUTPutPageConvertToJpeg
PUTPutEpubInStorageToPdf
GETDownloadFile
PUTPutSoundAnnotationDataExtract
PUTUploadFile
POSTPostDocumentTextReplace
PUTPutLineAnnotation
GETGetPageScreenAnnotations
GETGetPdfInStorageToXlsx
PUTPutFileAttachmentAnnotationDataExtract
GETStorageExists
GETGetRadioButtonField
DELETEDeleteDocumentStamps
GETGetDocument
PUTPutStrikeOutAnnotation
GETGetDocumentPopupAnnotationsByParent
GETGetImage
GETGetLineAnnotation
POSTPostPageCertify
GETGetField
DELETEDeleteDocumentTables
PUTPutTable
PUTPutPolygonAnnotation
DELETEDeleteAnnotation
GETGetImages
GETGetPageInkAnnotations
PUTPutAddText
PUTPutPolyLineAnnotation
POSTPostPageLinkAnnotations
POSTPostPageHighlightAnnotations
GETGetPdfInStorageToPptx
PUTPutImagesExtractAsPng
PUTPutPageAddStamp
GETGetPdfInStorageToSvg
GETGetDocumentFileAttachmentAnnotations
GETGetDocumentAttachmentByIndex
DELETEDeleteDocumentBookmarks
PUTPutPdfInRequestToHtml
PUTMoveFolder
POSTPostPageSquareAnnotations
GETGetDocumentProperties
PUTPutImageExtractAsGif
GETGetDocumentSquigglyAnnotations
PUTPutPdfInStorageToTiff
PUTPutPageConvertToPng
POSTPostDocumentImageHeader
GETGetPageMovieAnnotations
DELETEDeletePage
PUTPutPageConvertToTiff
GETGetImageExtractAsGif
POSTPostPageCaretAnnotations
GETGetDocumentSquareAnnotations
PUTPutSquigglyAnnotation
POSTPostPageRedactionAnnotations
DELETEDeletePageStamps
GETGetImportFieldsFromXmlInStorage
PUTPutLaTeXInStorageToPdf
PUTPutFreeTextAnnotation
POSTPostInsertImage
PUTPutImageExtractAsJpeg
GETGetDocumentCheckBoxFields
PUTPutSquareAnnotation
PUTPutChangePasswordDocument
GETGetPageStampAnnotations
GETGetPdfInStorageToPdfA
GETGetDocumentBookmarks
GETGetPagePolygonAnnotations
GETGetSquigglyAnnotation
GETGetPdfInStorageToTiff
GETGetMovieAnnotation
POSTPostPageInkAnnotations
PUTPutPdfInRequestToLaTeX
POSTPostBookmark
GETGetStrikeOutAnnotation
POSTPostPageLineAnnotations
POSTPostCheckBoxFields
PUTPutReplaceImage
PUTPutPdfInRequestToEpub
PUTPutPdfInStorageToPdfA
PUTPutPdfInRequestToXps
GETGetPageFileAttachmentAnnotations
GETGetTextBoxField
POSTPostPopupAnnotation
PUTPutPdfInRequestToSvg
GETGetDocumentStamps
GETGetStampAnnotation
PUTPutFileAttachmentAnnotation
GETGetPageRadioButtonFields
PUTPutPdfInRequestToXlsx
GETGetSquareAnnotation
GETGetCaretAnnotation
GETGetImportFieldsFromFdfInStorage
GETGetPageStamps
GETGetDocumentStrikeOutAnnotations
PUTPutHighlightAnnotation
GETGetDocumentSignatureFields
POSTPostChangePasswordDocumentInStorage
DELETEDeletePageLinkAnnotations
PUTCreateFolder
GETGetPageAnnotations
GETGetPageSquareAnnotations
PUTPutPdfInRequestToXml
POSTPostImportFieldsFromFdf
POSTPostDocumentTextFooter
GETGetPageTables
GETGetPageCaretAnnotations
PUTPutEncryptDocument
GETGetPolyLineAnnotation
POSTPostPageImageStamps
GETGetDocumentStampAnnotations
PUTPutPdfInStorageToXps
PUTPutStampAnnotation
PUTPutXmlInStorageToPdf
PUTPutMhtInStorageToPdf
GETGetPdfInStorageToXml
GETGetXpsInStorageToPdf
PUTPutCreateDocument
POSTPostImportFieldsFromXml
GETGetSoundAnnotationData
PUTPutPdfInRequestToTiff
GETGetDocumentScreenAnnotations
PUTPutCircleAnnotation
PUTPutMovieAnnotation
POSTPostPageStrikeOutAnnotations
GETGetPageTextAnnotations
POSTPostFlattenDocument
PUTCopyFile
PUTPutImagesExtractAsJpeg
GETGetImageExtractAsPng
GETGetDocumentHighlightAnnotations
GETGetVerifySignature
GETGetPdfInStorageToHtml
POSTPostPageFreeTextAnnotations
GETGetExportFieldsFromPdfToFdfInStorage
PUTPutUpdateFields
PUTPutXpsInStorageToPdf
GETGetPageLineAnnotations
PUTPutPdfInRequestToPdfA
GETGetPopupAnnotation
GETGetPageSquigglyAnnotations
GETGetMarkdownInStorageToPdf
GETGetTable
GETGetDocumentTextAnnotations
GETGetDocumentUnderlineAnnotations
GETGetPageConvertToTiff
GETGetBookmarks
PUTPutCaretAnnotation
GETGetPdfInStorageToMobiXml
PUTPutXslFoInStorageToPdf
PUTPutPdfInRequestToPptx
DELETEDeleteTable
GETGetCheckBoxField
GETGetPagePolyLineAnnotations
GETGetText
GETGetImportFieldsFromXfdfInStorage
GETGetPclInStorageToPdf
GETGetXslFoInStorageToPdf
GETGetPolygonAnnotation
GETGetPageConvertToPng
PUTPutPdfInRequestToMobiXml
PUTMoveFile
GETGetDocumentPopupAnnotations
PUTPutMergeDocuments
PUTPutTextAnnotation
PUTPutStampAnnotationDataExtract
PUTPutUnderlineAnnotation
DELETEDeleteBookmark
GETGetCircleAnnotation
PUTPutRedactionAnnotation
GETGetHighlightAnnotation
DELETEDeleteImage
GETGetPdfInStorageToDoc
POSTPostPageTables
GETGetDocumentSoundAnnotations
DELETEDeleteProperties
GETGetPageLinkAnnotations
POSTPostEncryptDocumentInStorage
PUTPutImagesExtractAsGif
POSTPostPageTextAnnotations
GETGetMhtInStorageToPdf
GETGetTextAnnotation
POSTPostCreateField
GETGetStampAnnotationData
PUTPutXfaPdfInRequestToAcroForm
GETGetLaTeXInStorageToPdf
DELETEDeletePageTables
GETGetPageLinkAnnotation
GETGetPageStrikeOutAnnotations
PUTPutPageConvertToGif
GETGetPdfInStorageToLaTeX
GETGetDocumentProperty
GETGetDocumentRedactionAnnotations
GETGetPageRedactionAnnotations
PUTPutPdfInStorageToLaTeX
PUTPutDecryptDocument
GETGetPageSignatureFields
GETGetFileAttachmentAnnotationData
PUTPutSearchableDocument
GETGetFilesList
GETGetDocumentLineAnnotations
PUTCopyFolder
POSTPostPageTextStamps
PUTPutHtmlInStorageToPdf
POSTPostPageScreenAnnotations
POSTPostPageCircleAnnotations
POSTPostTextBoxFields
GETGetPageText
POSTPostSplitDocument
PUTPutExportFieldsFromPdfToXfdfInStorage
PUTPutPdfInStorageToHtml
POSTPostPagePdfPageStamps
GETGetDownloadDocumentAttachmentByIndex
POSTPostPageStampAnnotations
GETGetPageConvertToBmp
PUTPutPsInStorageToPdf
DELETEDeleteFile
POSTPostPageFileAttachmentAnnotations
PUTPutPageConvertToEmf
GETGetFileVersions
PUTPutPrivileges
POSTPostDocumentTextHeader
POSTPostPageSquigglyAnnotations
GETGetPdfInStorageToXps
DELETEDeleteStamp
POSTPostSignDocument
GETGetPagePopupAnnotations
POSTPostDocumentPageNumberStamps
GETGetPdfInStorageToXls
PUTPutFieldsFlatten
GETGetDocumentRadioButtonFields
PUTPutImportFieldsFromFdfInStorage
GETGetPageTextBoxFields
PUTPutSoundAnnotation
POSTPostPageUnderlineAnnotations
GETGetPageConvertToGif
PUTPutInkAnnotation
GETGetImageExtractAsTiff
DELETEDeleteDocumentLinkAnnotations
PUTPutImageInStorageToPdf
DELETEDeleteFolder
GETGetUnderlineAnnotation
DELETEDeleteDocumentAnnotations
GETGetDocumentPolygonAnnotations
PUTPutPdfInRequestToDoc
PUTPutPdfInStorageToMobiXml
PUTPutXfaPdfInStorageToAcroForm
GETObjectExists
PUTPutPageConvertToBmp
GETGetPageConvertToEmf
GETGetFields
POSTPostImportFieldsFromXfdf
GETGetDocumentCaretAnnotations
PUTPutPdfInStorageToXls
GETGetWordsPerPage
GETGetSoundAnnotation
GETGetImageExtractAsJpeg
PUTPutCheckBoxField
DELETEDeleteLinkAnnotation
PUTPutAnnotationsFlatten
PUTPutTextBoxField
PUTPutUpdateField
GETGetWebInStorageToPdf
GETGetSignatureField
GETGetDocumentCircleAnnotations
PUTPutPdfInStorageToDoc
PUTPutScreenAnnotationDataExtract
GETGetInkAnnotation
POSTPostAppendDocument
PUTPutImageExtractAsPng
PUTPutPdfInStorageToPptx
GETGetExportFieldsFromPdfToXfdfInStorage
PUTPutRadioButtonField
PUTPutSetProperty
PUTPutImportFieldsFromXfdfInStorage
PUTPutImportFieldsFromXmlInStorage
GETGetDiscUsage
GETGetPageUnderlineAnnotations
GETGetXfaPdfInStorageToAcroForm
GETGetDocumentFreeTextAnnotations
PUTPutPclInStorageToPdf
PUTPutAddNewPage
GETGetPageHighlightAnnotations
GETGetDocumentTables
POSTPostPageTextReplace
GETGetDocumentTextBoxFields
POSTPostOptimizeDocument
GETGetDocumentInkAnnotations
PUTPutLinkAnnotation
PUTPutExportFieldsFromPdfToXmlInStorage
GETGetPage
PUTPutBookmark
GETGetDocumentPolyLineAnnotations
GETGetPageFreeTextAnnotations
PUTPutScreenAnnotation
GETGetPageConvertToJpeg
GETGetPages
PUTPutImageExtractAsTiff
GETGetLinkAnnotation
PUTPutMarkdownInStorageToPdf
POSTPostPageMovieAnnotations
POSTPostDocumentImageFooter
GETGetScreenAnnotationData
GETGetExportFieldsFromPdfToXmlInStorage
GETGetFileAttachmentAnnotation
GETGetScreenAnnotation
POSTPostPagePolyLineAnnotations
GETGetRedactionAnnotation
GETGetBookmark
GETGetDocumentAttachments
GETGetDocumentMovieAnnotations
POSTPostSignPage
POSTPostMovePage
GETGetFreeTextAnnotation
PUTPutPdfInRequestToHtml

Converts PDF document (in request content) to Html format and uploads resulting file to storage.

Authorization:

JSON Web Token

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
AuthorizationOAUTH2
REQUIREDJSON Web Token
Required Parameters
outPathSTRING
REQUIREDFull resulting filename (ex. /folder1/folder2/result.html)
Optional Parameters
fileBINARY
OPTIONALA file to be converted.
storageSTRING
OPTIONALThe document storage.
defaultFontNameSTRING
OPTIONALSpecifies the name of an installed font which is used to substitute any document font that is not embedded and not installed in the system. If null then default substitution font is used.
imageResolutionNUMBER
OPTIONALResolution for image rendering.
lettersPositioningMethodSTRING
OPTIONALThe mode of positioning of letters in words in result HTML.
documentTypeSTRING
OPTIONALResult document type.
explicitListOfSavedPagesARRAY
OPTIONALWith this property You can explicitely define what pages of document should be converted. Pages in this list must have 1-based numbers. I.e. valid numbers of pages must be taken from range (1...[NumberOfPagesInConvertedDocument]) Order of appearing of pages in this list does not affect their order in result HTML page(s) - in result pages allways will go in order in which they are present in source PDF.
convertMarkedContentToLayersBOOLEAN
OPTIONALIf attribute ConvertMarkedContentToLayers set to true then an all elements inside a PDF marked content (layer) will be put into an HTML div with "data-pdflayer" attribute specifying a layer name. This layer name will be extracted from optional properties of PDF marked content. If this attribute is false (by default) then no any layers will be created from PDF marked content.
useZOrderBOOLEAN
OPTIONALIf attribute UseZORder set to true, graphics and text are added to resultant HTML document accordingly Z-order in original PDF document. If this attribute is false all graphics is put as single layer which may cause some unnecessary effects for overlapped objects.
compressSvgGraphicsIfAnyBOOLEAN
OPTIONALThe flag that indicates whether found SVG graphics(if any) will be compressed(zipped) into SVGZ format during saving.
trySaveTextUnderliningAndStrikeoutingInCssBOOLEAN
OPTIONALPDF itself does not contain underlining markers for texts. It emulated with line situated under text. This option allows converter try guess that this or that line is a text's underlining and put this info into CSS instead of drawing of underlining graphically.
fixedLayoutBOOLEAN
OPTIONALThe value indicating whether that HTML is created as fixed layout.
fontEncodingStrategySTRING
OPTIONALDefines encoding special rule to tune PDF decoding for current document.
specialFolderForAllImagesSTRING
OPTIONALThe path to directory to which must be saved any images if they are encountered during saving of document as HTML. If parameter is empty or null then image files(if any) wil be saved together with other files linked to HTML It does not affect anything if CustomImageSavingStrategy property was successfully used to process relevant image file.
antialiasingProcessingSTRING
OPTIONALThe parameter defines required antialiasing measures during conversion of compound background images from PDF to HTML.
saveShadowedTextsAsTransparentTextsBOOLEAN
OPTIONALPdf can contain texts that are shadowed by another elements (f.e. by images) but can be selected to clipboard in Acrobat Reader (usually it happen when document contains images and OCRed texts extracted from it). This settings tells to converter whether we need save such texts as transparent selectable texts in result HTML to mimic behaviour of Acrobat Reader (othervise such texts are usually saved as hidden, not available for copying to clipboard).
rasterImagesSavingModeSTRING
OPTIONALConverted PDF can contain raster images This parameter defines how they should be handled during conversion of PDF to HTML.
additionalMarginWidthInPointsNUMBER
OPTIONALDefines width of margin that will be forcibly left around that output HTML-areas.
fontSavingModeSTRING
OPTIONALDefines font saving mode that will be used during saving of PDF to desirable format.
splitCssIntoPagesBOOLEAN
OPTIONALWhen multipage-mode selected(i.e 'SplitIntoPages' is 'true'), then this attribute defines whether should be created separate CSS-file for each result HTML page.
partsEmbeddingModeSTRING
OPTIONALIt defines whether referenced files (HTML, Fonts,Images, CSSes) will be embedded into main HTML file or will be generated as apart binary entities.
minimalLineWidthNUMBER
OPTIONALThis attribute sets minimal width of graphic path line. If thickness of line is less than 1px Adobe Acrobat rounds it to this value. So this attribute can be used to emulate this behavior for HTML browsers.
specialFolderForSvgImagesSTRING
OPTIONALThe path to directory to which must be saved only SVG-images if they are encountered during saving of document as HTML. If parameter is empty or null then SVG files(if any) wil be saved together with other image-files (near to output file) or in special folder for images (if it specified in SpecialImagesFolderIfAny option). It does not affect anything if CustomImageSavingStrategy property was successfully used to process relevant image file.
splitIntoPagesBOOLEAN
OPTIONALThe flag that indicates whether each page of source document will be converted into it's own target HTML document, i.e whether result HTML will be splitted into several HTML-pages.
preventGlyphsGroupingBOOLEAN
OPTIONALThis attribute switch on the mode when text glyphs will not be grouped into words and strings This mode allows to keep maximum precision during positioning of glyphs on the page and it can be used for conversion documents with music notes or glyphs that should be placed separately each other. This parameter will be applied to document only when the value of FixedLayout attribute is true.
htmlMarkupGenerationModeSTRING
OPTIONALSometimes specific reqirments to generation of HTML markup are present. This parameter defines HTML preparing modes that can be used during conversion of PDF to HTML to match such specific requirments.
pagesFlowTypeDependsOnViewersScreenSizeBOOLEAN
OPTIONALIf attribute 'SplitOnPages=false', than whole HTML representing all input PDF pages will be put into one big result HTML file. This flag defines whether result HTML will be generated in such way that flow of areas that represent PDF pages in result HTML will depend on screen resolution of viewer.
cssClassNamesPrefixSTRING
OPTIONALWhen PDFtoHTML converter generates result CSSs, CSS class names (something like ".stl_01 {}" ... ".stl_NN {}) are generated and used in result CSS. This property allows forcibly set class name prefix.
removeEmptyAreasOnTopAndBottomBOOLEAN
OPTIONALDefines whether in created HTML will be removed top and bottom empty area without any content (if any).
saveTransparentTextsBOOLEAN
OPTIONALPdf can contain transparent texts that can be selected to clipboard (usually it happen when document contains images and OCRed texts extracted from it). This settings tells to converter whether we need save such texts as transparent selectable texts in result HTML.
Code Snippet
Install SDK
Response ExampleSchema

Install SDK for (Node.js)Unirest

OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication