Convert Excel to Markdown – Aspose.Cells Cloud API Documentation
This REST API converts a spreadsheet file to a Markdown-format file.
Security and Authentication
The Aspose.Cells Cloud APIs are secure and require JWT token-based authentication.
REST API
POST https://api.aspose.cloud/v3.0/cells/convert/markdown
Security and Authentication
The Aspose.Cells Cloud APIs are secure and require JWT token-based authentication.
Query Parameters
| Parameter Name | Type | Location | Description |
|---|---|---|---|
| password | string | query | Password required to open the Excel file. |
| storageName | string | query | Name of the storage where the file is located. |
| checkExcelRestriction | bool | query | Indicates whether to enforce Excel‑specific restrictions when modifying cells or related objects. |
| datafile | file | body | The Excel file to be uploaded as the first part of the multipart content. |
Response
The API returns a JSON object of type FileInfo:
- FileInfo – object containing the name, size, and base‑64‑encoded content of the generated Markdown file.
{
"Filename": "example.md",
"FileSize": 12345,
"FileContent": "base64_encoded_string"
}
Error Responses
| HTTP Code | Description | Example JSON Body |
|---|---|---|
| 401 | Unauthorized – missing or invalid token. | {"error":"Invalid access token."} |
| 400 | Bad Request – missing required parameters or invalid file format. | {"error":"The 'datafile' field is required."} |
| 500 | Internal Server Error – unexpected server problem. | {"error":"An unexpected error occurred."} |
How to Use the PostConvertWorkbookToMarkdown API with SDKs
PostConvertWorkbookToMarkdown API Specification
The OpenAPI Specification defines a publicly accessible programming interface and lets you perform REST interactions directly from a web browser.
You can use the cURL command‑line tool to access Aspose.Cells web services easily. The example below shows how to call the Cloud API with cURL.
Use Aspose.Cells Cloud SDKs
Using an SDK is the fastest way to develop. An SDK handles low‑level details so you can focus on your business logic. See the GitHub repository for a complete list of Aspose.Cells Cloud SDKs.
The following code examples demonstrate how to call Aspose.Cells web services using various SDKs:
Other APIs that Implement This Function
- POST /cells/{name}/saveAs – Saves an Excel file as HTML with additional settings and stores the result.
- PUT /cells/convert – Converts an Excel file to HTML with extra options and returns the result in the response.
- GET /cells/{name} – Retrieves an Excel file and can convert it to HTML with optional settings.