Batch Convert Excel Files

This REST API enables batch conversion of eligible files.

REST API

POST http://api.aspose.cloud/v3.0/cells/batch/convert

Security and Authentication

The Aspose.Cells Cloud APIs are secure and require JWT token-based authentication.

Request Parameters

Parameter Name	Type	Location	Description
batchConvertRequest	object	body	Request body containing conversion settings.

BatchConvertRequest Properties

Name	Type	Description	Notes
SourceFolder	string	Path to the folder that contains the source Excel files.	[optional]
MatchCondition	MatchConditionRequest	Conditions used to select files for conversion.	[optional]
Format	string	Target format for conversion (e.g., `pdf`, `csv`).	[optional]
OutFolder	string	Destination folder where converted files will be saved.	[optional]
SaveOptions	SaveOptions	Additional options that control how files are saved.	[optional]

MatchConditionRequest Properties

Name	Type	Description	Notes
RegexPattern	string	Regular expression used to filter file names.	[optional]
FullMatchConditions	string[]	List of exact file name conditions for matching.	[optional]

Request Body Parameter

Parameter Name	Type	Description
data	file	Binary content of the workbook file to create.

Response

{
    "Name": "ResponseFile",
    "DataType": {
        "Identifier": "File",
        "Reference": "Stream",
        "Name": "file"
    }
}

HTTP Status Codes

Code	Meaning	When Returned
200 OK	Workbook created successfully	Normal flow
201 Created	Workbook created (alternative response)	When the API returns a created status
400 Bad Request	Invalid parameters	Client‑side error
401 Unauthorized	Missing or invalid token	Authentication error
409 Conflict	File exists and `isWriteOver=false`	Conflict with existing file

How to Use the PostBatchConvert API with SDKs

PostBatchConvert API Specification

The OpenAPI Specification defines a publicly accessible programming interface and lets you carry out REST interactions directly from a web browser.

You can use the cURL command‑line tool to access Aspose.Cells web services easily. The following example shows how to make calls to the Cloud API with cURL.

Request

curl -v "http://api.aspose.cloud/v3.0/cells/batch/convert" \
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer <jwt token>" \
-D "{\"SourceFolder\":\"CellsTests\",\"OutFolder\":\"Output\",\"MatchCondition\":{\"RegexPattern\":\"(^Book)(.+)(xlsx$)\"},\"Format\":\"pdf\",\"SaveOptions\":{\"SaveFormat\":\"pdf\",\"CalculateFormula\":true,\"EnableHTTPCompression\":true,\"OnePagePerSheet\":true,\"CreateDirectory\":false,\"Compliance\":\"None\"}}"

Response

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

Use Aspose.Cells Cloud SDKs

Using an SDK is the best way to speed up development. An SDK handles low‑level details and lets you focus on your project tasks. Please check out the GitHub repository for a complete list of Aspose.Cells Cloud SDKs.

The following code examples demonstrate how to make calls to Aspose.Cells web services using various SDKs: