Skip to main content

Aspose Component

Convert and manipulate documents and PDFs in Aspose.

Component key: aspose

Changelog ↓

Description

Aspose is a cloud-based file manipulation platform that provides APIs for document processing and format conversion. This component allows you to convert documents between formats (PDF, DOCX, HTML), merge and split documents, and extract text and metadata from files.

API Documentation

This component was built using the Aspose Words Cloud API and Aspose PDF Cloud API.

Connections

Aspose API Key

key: apiKey

To authenticate with Aspose, an application must be created in the Aspose Developer Dashboard to obtain a Client ID and Client Secret.

Prerequisites

Setup Steps

  1. Log in to the Aspose Developer Dashboard using an Aspose account
  2. Navigate to the Applications view
  3. Click Create New Application or Add Application
  4. Fill in the required application details and save
  5. After creating the application, Aspose will generate a Client ID and Client Secret
  6. Copy both the Client ID and Client Secret values

Configure the Connection

  • Enter the Client ID into the Application Client ID field
  • Enter the Client Secret into the Application Client Secret field

For more information about the Aspose REST API, refer to the Aspose API documentation.

InputNotesExample
Aspose API Base URL

Base URL for the Aspose API.

https://api.aspose.cloud
Application Client ID

Client ID of your Aspose Application.

a1b2c3d4-e5f6-7890-abcd-ef1234567890
Application Client Secret

Client Secret of your Aspose Application.

Actions

Convert Cloud Storage Document

Converts a document in cloud storage to the specified format. | key: convertCloudStorageDocument

InputNotesExample
Connection

The Aspose connection to use.

Password

Password of protected Word document.

File Name

Name of the file inside the storage

document.pdf
Folder Name

The name of the folder in the storage.

/folder1/document.pdf
Format

The destination format for the converted file.

pdf
Load Encoding

Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

UTF-8
Out Path

The path to the output document.

/folder1/document.pdf
Storage

Original document storage.

MyStorage

{
"data": {}
}

Convert Diagram

Converts document from the request's content to the specified format. | key: convertDiagram

InputNotesExample
Connection

The Aspose connection to use.

File Content

Reference of a file from a previous step to upload.

File Name

Download Document Name

flowchart.vsdx

{
"data": "<binary data of diagram converted>"
}

Convert HTML to PDF

Converts HTML file in storage to PDF format. | key: convertHtmlToPdf

InputNotesExample
Connection

The Aspose connection to use.

Destination Path

The destination document folder.

/destination
Document Name

The document name located in storage. (Note, this input is required in case you want to save the resulting file in an Aspose storage).

flowchart.vsdx
Page Height

Desired page height (in px).

1024
HTML File Name

Name of HTML file in ZIP archive.

index.html
Is Landscape

When true, uses landscape page orientation.

false
Margin Bottom

Page margin bottom (in px).

20
Margin Left

Page margin left (in px).

20
Margin Right

Page margin right (in px).

20
Margin Top

Page margin top (in px).

20
Source Folder Path

Full source filename (ex. /folder1/folder2/template.zip). Note: this input is required in case you want to get the resulting file in the response.

/Folder1/Folder2
Storage Name

The document storage which contains the file.

MyStorage
Upload to Storage

When true, saves the post-conversion file to Aspose storage. When false, the resulting file is returned in the response body.

false
Page Width

Desired page width (in px).

768

{
"data": {
"Code": 200,
"Status": "OK"
}
}

Convert Local Document

Converts a document on a local drive to the specified format. | key: convertLocalDocument

InputNotesExample
Connection

The Aspose connection to use.

Document

The document to convert.

Password

Password of protected Word document.

File Name Field Value

The filename of the output document. This will be used when the resulting document has a dynamic field (filename). If not set, the document name will be used instead.

output.pdf
Format

The destination format for the converted file.

pdf
Load Encoding

Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

UTF-8
Out Path

The path to the output document on a local storage.

/folder1/document.pdf
Storage

Original document storage name.

MyStorage

{
"data": "<binary data of file converted>"
}

Convert PDF to DOC

Converts PDF document to DOC format. | key: convertPdfToDoc

InputNotesExample
Add Return to Line End

When true, adds a return character at the end of each line.

false
Connection

The Aspose connection to use.

Document Name

The name of the document inside Aspose. (Note: this input is required when the file to convert is located in an Aspose storage.)

flowchart.vsdx
Password

The file password.

File Content

File to convert, if missing, action will assume that the file is located in an Aspose storage.

Folder Path

The Document folder

folder1
Format

Allows to specify .doc or .docx file format.

pdf
Image Resolution X

Image resolution X (horizontal).

1920
Image Resolution Y

Image resolution Y (vertical).

1080
Max Distance Between Text Lines

Max distance between text lines (in px).

15
Conversion Mode

Controls how a PDF document is converted into a word processing document.

Out Path

Full resulting filename. Note: This field is required when the post-conversion file needs to be saved in an Aspose storage.

/folder1/folder2/result.docx
Recognize Bullets

When true, the converter recognizes and preserves bullet points.

false
Relative Horizontal Proximity

Relative horizontal proximity (in px).

15
Storage Name

Aspose storage name where the folder gets read or created.

MyStorage
Upload to Storage

When true, saves the post-conversion file to Aspose storage. When false, the resulting file is returned in the response body.

false

{
"data": {
"Code": 200,
"Status": "OK"
}
}

Convert PDF to HTML

Converts a PDF to HTML format. | key: convertPdfToHtml

InputNotesExample
Additional Margin Width In Points

Defines width of margin that will be left around output HTML areas.

10
Antialiasing Processing

Defines antialiasing measures during conversion of compound background images from PDF to HTML.

Compress SVG Graphics If Any

When true, compresses SVG graphics into SVGZ format during saving.

false
Connection

The Aspose connection to use.

Convert Marked Content To Layers

When true, converts PDF marked content (layers) into HTML divs with 'data-pdflayer' attributes specifying layer names.

false
CSS Class Names Prefix

Sets a prefix for CSS class names generated during PDF to HTML conversion.

aspose-
Default Font Name

Specifies the name of an installed font used to substitute any document font that is not embedded or installed in the system. If not specified, the default substitution font is used.

Arial
Document Name

The name of the document inside Aspose. (Note: this input is required when the file to convert in located in an Aspose storage.)

flowchart.vsdx
Format

Result document type.

pdf
File Content

File to convert, if missing, action will assume that the file is located in an Aspose storage.

Fixed Layout

When true, creates the HTML as a fixed layout.

false
Folder Name

The document folder

folder1
Font Encoding Strategy

Defines encoding rule to tune PDF decoding for the current document.

Font Saving Mode

Defines font saving mode used during PDF conversion.

HTML Markup Generation Mode

Defines HTML markup generation mode during PDF to HTML conversion.

WriteAllHtml
Image Resolution

Resolution for image rendering.

300
Letters Positioning Method

The mode of positioning letters in words in the result HTML.

Minimal Line Width

Minimal line width.

1
Out Path

Full resulting filename. Note: This field is required when the post-conversion file needs to be saved in an Aspose storage.

/folder1/folder2/result.docx
Pages Flow Type Depends On Viewers Screen Size

When true, flow areas representing PDF pages in the result HTML adapt to the viewer's screen resolution. Only applies when 'Split Into Pages' is false.

false
Parts Embedding Mode

Defines whether referenced files (HTML, Fonts, Images, CSS) will be embedded into the main HTML file or generated as separate files.

Prevent Glyphs Grouping

When true, prevents text glyphs from being grouped into words. Useful for documents with music notes or glyphs that should be positioned precisely. Only applies when Fixed Layout is true.

false
Raster Images Saving Mode

Defines how raster images in the PDF should be handled during conversion to HTML.

Remove Empty Areas On Top And Bottom

When true, removes empty areas at the top and bottom of the created HTML that have no content.

false
Save Shadowed Texts As Transparent Texts

When true, saves text that is shadowed by other elements (e.g., images with OCR text) as transparent selectable text in the result HTML, mimicking Acrobat Reader behavior.

false
Save Transparent Texts

When true, saves transparent text (typically OCR text from images) as transparent selectable text in the result HTML.

false
Special Folder For All Images

The path to directory where images will be saved during HTML conversion. If empty, images are saved with other HTML-linked files.

/images
Special Folder For SVG Images

The path to directory where SVG images will be saved during HTML conversion. If empty, SVG images are saved with other HTML-linked files.

/svg
Split CSS Into Pages

When true, creates separate CSS files for each HTML result page. Only applies when 'Split Into Pages' is enabled.

false
Split Into Pages

When true, converts each page of the source document into a separate HTML file.

false
Storage Name

Aspose storage name where the folder gets read or created.

MyStorage
Try Save Text Underlining And Strikethrough In CSS

When true, attempts to detect text underlining and strikethrough (which PDF emulates with lines) and represent them using CSS instead of graphical elements.

false
Upload to Storage

When true, saves the post-conversion file to Aspose storage. When false, the resulting file is returned in the response body.

false
Use Z-Order

When true, graphics and text are added to the HTML document according to the Z-order in the original PDF. When false, all graphics are rendered as a single layer.

false

{
"data": {
"Code": 200,
"Status": "OK"
}
}

Copy File

Copies a file. | key: copyFile

InputNotesExample
Connection

The Aspose connection to use.

Destination Folder Path

Destination file path.

/destination
Destination Storage Name

Destination storage name.

MyStorage
File Version ID

File version ID to download. If not specified, the latest version is used.

v1.2.3
Source Folder Path

Source file's path. e.g: '/Folder1/fole.ext or '/Bucket/Folder1/file.ext'

/Folder1/Folder2
Source Storage Name

Source storage name.

MyStorage

{
"data": null
}

Copy Folder

Copies a folder. | key: copyFolder

InputNotesExample
Connection

The Aspose connection to use.

Destination Folder Path

Destination folder path.

/destination
Destination Storage Name

Destination storage name.

MyStorage
Source Folder Path

Source folder path.

/Folder1/Folder2
Source Storage Name

Source storage name.

MyStorage

{
"data": null
}

Create Document

Creates a new document in cloud storage in the format, determined by the file extension. All save format extensions are supported. | key: createDocument

InputNotesExample
Connection

The Aspose connection to use.

File Name

Name of the file to upload.

document.pdf

{
"data": {
"StatusCode": 200,
"Status": "OK"
}
}

Create Folder

Creates a folder. | key: createFolder

InputNotesExample
Connection

The Aspose connection to use.

Folder Path

Target folder's path. The folders will be created recursively.

/Folder1/Folder2
Storage Name

Aspose storage name where the folder gets read or created.

MyStorage

{
"data": null
}

Delete File

Deletes a file. | key: deleteFile

InputNotesExample
Connection

The Aspose connection to use.

File Path

Path of the file including the file name and extension.

/folder1/document.pdf
File Version ID

File version ID to download. If not specified, the latest version is used.

v1.2.3
Storage Name

Storage name.

MyStorage

{
"data": null
}

Delete Folder

Deletes a folder. | key: deleteFolder

InputNotesExample
Connection

The Aspose connection to use.

Folder Path

Target folder's path. The folders will be created recursively.

/Folder1/Folder2
Recursive

When true, deletes folders, subfolders, and files recursively.

false
Storage Name

Aspose storage name where the folder gets read or created.

MyStorage

{
"data": null
}

Download File

Downloads a file. | key: downloadFile

InputNotesExample
Connection

The Aspose connection to use.

File Path

Path of the file including the file name and extension.

/folder1/document.pdf
File Version ID

File version ID to download. If not specified, the latest version is used.

v1.2.3
Storage Name

Storage name.

MyStorage

{
"data": "<binary data of file downloaded>"
}

Get Diagram

Exports the document into the specified format. | key: getDiagram

InputNotesExample
Connection

The Aspose connection to use.

Diagram Name

The name of the diagram.

flowchart.vsdx
Folder Path

The folder path where original diagram is located.

/Folder1/Folder2
Format

The destination format for the converted file.

pdf

{
"data": "<binary data of diagram downloaded>"
}

Get Document

Reads common information from the document. | key: getDocument

InputNotesExample
Connection

The Aspose connection to use.

Document Name

The filename of the input document.

document.pdf
Folder Path

The path to the folder where the document is located.

/Folder1/Folder2
Storage Name

Storage name.

MyStorage

{
"data": {
"Document": {
"Links": [
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest",
"Rel": "self"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=doc",
"Rel": "alternate",
"Type": "application/msword",
"Title": "Download as DOC"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=dot",
"Rel": "alternate",
"Type": "application/msword",
"Title": "Download as DOT"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=docx",
"Rel": "alternate",
"Type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"Title": "Download as DOCX"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=docm",
"Rel": "alternate",
"Type": "application/vnd.ms-word.document.macroEnabled.12",
"Title": "Download as DOCM"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=dotx",
"Rel": "alternate",
"Type": "application/vnd.openxmlformats-officedocument.wordprocessingml.template",
"Title": "Download as DOTX"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=dotm",
"Rel": "alternate",
"Type": "application/vnd.ms-word.template.macroEnabled.12",
"Title": "Download as DOTM"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=flatopc",
"Rel": "alternate",
"Type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"Title": "Download as FLATOPC"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=rtf",
"Rel": "alternate",
"Type": "application/rtf",
"Title": "Download as RTF"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=wml",
"Rel": "alternate",
"Type": "text/xml",
"Title": "Download as WML"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=odt",
"Rel": "alternate",
"Type": "application/vnd.oasis.opendocument.text",
"Title": "Download as ODT"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=ott",
"Rel": "alternate",
"Type": "application/vnd.oasis.opendocument.text-template",
"Title": "Download as OTT"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=txt",
"Rel": "alternate",
"Type": "text/plain",
"Title": "Download as TXT"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=mhtml",
"Rel": "alternate",
"Type": "multipart/related",
"Title": "Download as MHTML"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=epub",
"Rel": "alternate",
"Type": "application/epub+zip",
"Title": "Download as EPUB"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=pdf",
"Rel": "alternate",
"Type": "application/pdf",
"Title": "Download as PDF"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=xps",
"Rel": "alternate",
"Type": "application/vnd.ms-xpsdocument",
"Title": "Download as XPS"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=openxps",
"Rel": "alternate",
"Type": "application/oxps",
"Title": "Download as OPENXPS"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=ps",
"Rel": "alternate",
"Type": "application/postscript",
"Title": "Download as PS"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=tiff",
"Rel": "alternate",
"Type": "image/tiff",
"Title": "Download as TIFF"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=png",
"Rel": "alternate",
"Type": "image/png",
"Title": "Download as PNG"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=jpeg",
"Rel": "alternate",
"Type": "image/jpeg",
"Title": "Download as JPEG"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=bmp",
"Rel": "alternate",
"Type": "image/bmp",
"Title": "Download as BMP"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=gif",
"Rel": "alternate",
"Type": "image/gif",
"Title": "Download as GIF"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=emf",
"Rel": "alternate",
"Type": "image/emf",
"Title": "Download as EMF"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=eps",
"Rel": "alternate",
"Type": "image/eps",
"Title": "Download as EPS"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=svg",
"Rel": "alternate",
"Type": "image/svg+xml",
"Title": "Download as SVG"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=html",
"Rel": "alternate",
"Type": "text/html",
"Title": "Download as HTML"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=htmlfixed",
"Rel": "alternate",
"Type": "text/html",
"Title": "Download as HTMLFIXED"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=pcl",
"Rel": "alternate",
"Type": "application/x-pcl",
"Title": "Download as PCL"
},
{
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx?folder=%2ftest&format=md",
"Rel": "alternate",
"Type": "text/markdown",
"Title": "Download as MD"
}
],
"FileName": "testPdf.docx",
"SourceFormat": "Docx",
"IsEncrypted": false,
"IsSigned": false,
"DocumentProperties": {
"Link": {
"Href": "http://api.aspose.cloud/v4.0/words/testPdf.docx/documentProperties?folder=%2ftest",
"Rel": "self"
}
}
},
"RequestId": "Root=1-65dfb304-6d7ffbc37ba1bebb44f6103c"
}
}

Get Files List

Get all files and folders within a folder. | key: getFilesList

InputNotesExample
Connection

The Aspose connection to use.

Folder Path

Target folder's path. The folders will be created recursively.

/Folder1/Folder2
Storage Name

Aspose storage name where the folder gets read or created.

MyStorage

{
"data": {
"Value": [
{
"Name": "file1",
"Path": "path1",
"IsFolder": false,
"Size": 100,
"ModifiedDate": "2021-01-01"
},
{
"Name": "file2",
"Path": "path2",
"IsFolder": false,
"Size": 200,
"ModifiedDate": "2021-01-02"
}
]
}
}

Load Web Document

Downloads a document from the web using URL and saves it to cloud storage in the specified format. | key: loadWebDocument

InputNotesExample
Connection

The Aspose connection to use.

Loading Document URL

The web document URL.

https://example.com/documents/file.pdf

{
"data": null
}

Move File

Moves a file. | key: moveFile

InputNotesExample
Connection

The Aspose connection to use.

Destination Folder Path

Destination file path.

/destination
Destination Storage Name

Destination storage name.

MyStorage
File Version ID

File version ID to download. If not specified, the latest version is used.

v1.2.3
Source Folder Path

Source file's path. e.g: '/Folder1/fole.ext or '/Bucket/Folder1/file.ext'

/Folder1/Folder2
Source Storage Name

Source storage name.

MyStorage

{
"data": null
}

Move Folder

Moves a folder. | key: moveFolder

InputNotesExample
Connection

The Aspose connection to use.

Destination Folder Path

Destination folder path.

/destination
Destination Storage Name

Destination storage name.

MyStorage
Source Folder Path

Source folder path.

/Folder1/Folder2
Source Storage Name

Source storage name.

MyStorage

{
"data": null
}

Save Diagram As

Converts document to destination format with detailed settings and saves result to storage. | key: saveDiagramAs

InputNotesExample
Connection

The Aspose connection to use.

Default Font

The default font for the diagram.

Arial
Destination File Name

The name of the converted file.

converted-document.pdf
Destination Folder Path

Destination folder path.

/destination
Original Document Name

Name of the original document.

document.pdf
Folder Name

Original document folder.

/Folder1/Folder2
Overwrite

When true, overwrites existing files with the same name.

false

{
"data": "<binary data of file downloaded>"
}

Save Document As

Converts a document in cloud storage to the specified format. | key: saveDocumentAs

InputNotesExample
Connection

The Aspose connection to use.

Destination File Name

The name of the converted file.

converted-document.pdf
Password

Password of protected Word document.

File Name

Name of the file to convert inside your Aspose Storage.

document.pdf
Folder Name

The name of the folder in the storage.

/folder1/document.pdf
Format

The destination format for the converted file.

pdf
Load Encoding

Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

UTF-8
Save Options Data

Provide save options related to the SaveFormat provided. For all save options, please refer to this link: https://reference.aspose.cloud/words/#/op/SaveAs (Toggle 'Advanced Parameters' on and then select a SaveOptionsData object congruent to the one chosen in the 'Format' input)

Storage

Original document storage name.

MyStorage

{
"data": null
}

Split Document

Splits a document into parts and saves them in the specified format. | key: splitDocument

InputNotesExample
Connection

The Aspose connection to use.

Destination File Name

Result path of the document after the operation. If this parameter is ommited then result of the operation will be saved as the source document.

converted-document.pdf
Document Name

The filename of the input document.

flowchart.vsdx
Password

Password of protected Word document.

Folder

Original document folder

folder1
Format

The format to split.

pdf
From Page

The start page from where to start the splitting process.

1
Load Encoding

Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

UTF-8
Storage Name

Aspose storage name where the folder gets read or created.

MyStorage
To Page

The end page where to end the splitting process.

10
Zip Output

When true, compresses the output into a ZIP file.

false

{
"data": {
"SplitResult": {
"Pages": [
{
"Href": "https://www.example.com/file_page1.ext",
"Rel": "page"
},
{
"Href": "https://www.example.com/file_page2.ext",
"Rel": "page"
}
],
"ZippedPages": {
"Href": "/test/test.docx.zip",
"Rel": "zippedpages"
},
"SourceDocument": {
"Href": "https://www.example.com/file.ext",
"Rel": "self"
}
}
}
}

Upload File

Uploads a file. | key: uploadFile

InputNotesExample
Connection

The Aspose connection to use.

File Content

Reference of a file from a previous step to upload.

File Path

Path of the file including the file name and extension.

/folder1/document.pdf
Storage Name

Storage name.

MyStorage

{
"data": null
}

Changelog

2026-01-30

Added global debug support across all actions for enhanced troubleshooting

2024-04-19

Enhanced Save Document As action with SaveOptions support for customized document conversion settings

2024-02-29

Initial release of Aspose component with comprehensive document and diagram management capabilities