Clear
The Clear Spreadsheet API is designed to be the definitive solution for developers who need to programmatically purge unwanted elements from spreadsheet files in a single, reliable call. This documentation page serves as your comprehensive guide, walking you through everything required to start integrating the service into your applications with confidence. We begin with an overview of the API's core concepts, explaining how the service interprets different spreadsheet formats—ranging from modern Office Open XML files (.xlsx) to legacy Excel binaries (.xls), as well as Apple Numbers, CSV, TSV, and a host of other tabular representations. Understanding these file-type nuances is essential because each format stores hyperlinks, images, charts, and embedded objects in distinct structures; the Clear API abstracts those complexities and presents a uniform interface that works across the board.
Main Features
Next, you'll find a detailed walkthrough of the authentication workflow. The platform uses industry-standard API keys and optional OAuth 2.0 tokens to guarantee that only authorized clients can invoke data-clearing operations. Security best practices, such as key rotation, IP whitelisting, and encrypted transmission via HTTPS, are covered in depth, ensuring you can safeguard both your own infrastructure and the end‑users' data. Following authentication, the “Getting Started” section provides a quick‑start code sample in multiple languages (cURL, Python, JavaScript, .NET, and Java), illustrating how to construct a request payload, attach the spreadsheet file, and interpret the response. The sample demonstrates the leanest possible request—just your API key, the file data, and an optional list of element types to clear—showcasing the API's promise of “one simple call.”
Documents
Parameters
- format: The operation name, what are: clearAll, clearHyperlinks, clearTables, clearPictures, clearShapes, clearComments, clearCharts, clearOleObjects, clearTextboxes, clearScenarios
- AppRequest.OperationTables: The operation name, what are: clearAll, clearHyperlinks, clearTables, clearPictures, clearShapes, clearComments, clearCharts, clearOleObjects, clearTextboxes, clearScenarios
- UploadFileRequest.OperationId: This is an operation id
- UploadFileRequest.Files: These are files you need to upload them to our online services, you can prepare the data in your very own way but it must follow the standard of the html input file.
Use The Endpoint
-
Send a request that includes the files and the access token Clear API
curl -X 'POST' \ 'https://api.sheetize.cloud/clear' \ -H 'accept: text/plain' \ -H 'Authorization: Bearer TheAccessToken' \ -H 'Content-Type: multipart/form-data' \ -F 'AppRequest.OperationTables=clearHyperlinks' \ -F 'UploadFileRequest.OperationId=' \ -F 'UploadFileRequest.Files=@AFileName.xlsx;type=application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' -
The service will respond with a download URL for the processed file, in this example it is:
{ "name": "", "type": "1", "size": 900000, "description": "", "linkToDownload": "/download/TheFolderName/TheFileName.xlsx", "message": "", "statusCode": 200 } -
Send a request that includes the file name and the folder name to Download API
curl -X 'GET' \ 'https://api.sheetize.cloud/download/TheFolderName/TheFileName.xlsx' \ -H 'accept: */*' \ -H 'Authorization: Bearer TheAccessToken' - You will receive the file and you can either use it or simply forward it to the next step of your workflow.
