Compress
Welcome to the official documentation for Compress, the lightweight yet powerful API designed to shrink spreadsheet files to a fraction of their original size with a single, intuitive request. In today’s data‑driven world, teams constantly exchange spreadsheets that contain everything from simple lists to complex financial models, and the sheer volume of these files can quickly become a hidden cost—slower uploads, increased storage fees, and longer processing times for downstream systems. Compress addresses these pain points by offering a cloud‑native service that intelligently analyses the internal structure of your spreadsheet, strips away unnecessary baggage, and repackages the content in an optimized, compact form without sacrificing data integrity or readability. This documentation page serves as your single source of truth, guiding you through everything you need to know to start using the API effectively, from authentication and request formatting to error handling and best‑practice strategies for batch processing. Whether you’re a seasoned backend engineer integrating data pipelines, a front‑end developer looking to improve the user experience when uploading files, or an IT manager tasked with reducing storage overhead across your organization, this guide will provide clear, step‑by‑step instructions, code snippets in multiple languages, and real‑world examples that illustrate how to achieve the best compression results for a wide variety of spreadsheet formats. Throughout the documentation you’ll find dedicated sections on security considerations—such as TLS encryption, signed JWT tokens, and GDPR‑compliant data handling—along with performance benchmarks that demonstrate typical latency and throughput under different workloads. We also include an extensive FAQ that covers common scenarios, a troubleshooting matrix for quick diagnosis of issues, and links to community forums where you can share insights with other developers who are leveraging Compress in production. By the end of this guide, you should feel confident in configuring your environments, sending a properly formed API call, and interpreting the response payloads, so you can seamlessly embed compression into your existing workflows and start seeing tangible savings on storage costs and network bandwidth right away. Dive in, explore the sections that match your role, and let Compress handle the heavy lifting of data reduction so you can focus on building richer, more responsive applications.
Main Features
The core of the Compress API revolves around a rich feature set that makes spreadsheet reduction both effortless and reliable. First and foremost, the service supports a broad spectrum of file types—including Apple Numbers, plain CSV and TSV files, as well as Microsoft Excel’s .xlsx and .xls formats—so you can send virtually any spreadsheet you encounter without needing a pre‑conversion step. Under the hood, the engine performs a multi‑phase optimization: it normalises the file’s internal XML or binary structure, eliminates duplicate styles, merges identical cell formats, removes hidden rows and columns that contain no data, and compacts embedded objects such as images, charts, and pivot tables by applying lossless compression algorithms tailored to each payload. In addition, the API detects and strips redundant metadata, comments, and versioning information that typically balloon file size but rarely serve a functional purpose. All of these operations happen in real time, delivering results in milliseconds for files up to 50 MB, and scaling gracefully to larger documents with graceful throttling and progress callbacks. Security is baked in—each request is transferred over HTTPS, and the service never retains a copy of your file beyond the short processing window, ensuring compliance with strict privacy regulations. From a developer’s perspective, the API is designed to be as frictionless as possible: a single POST to the `/compress` endpoint with the file attached as multipart/form‑data returns a JSON response containing the new file’s download URL, original and compressed sizes, and a checksum for verification. Optional parameters let you fine‑tune the compression level, preserve specific sheets, or whitelist certain embedded objects if you need to retain full fidelity for downstream applications. Comprehensive SDKs are available for Python, Node.js, Java, and Go, each exposing a concise wrapper method—`compressSpreadsheet(filePath, options)`—that abstracts away the HTTP layer entirely. Detailed rate‑limit documentation and bulk‑upload endpoints enable you to process thousands of files per hour without overloading your infrastructure, while built‑in retry logic and exponential back‑off handling keep your pipelines robust against transient network hiccups. In short, the Compress API delivers a fast, secure, and developer‑friendly solution that reduces spreadsheet storage footprints, accelerates file transfers, and simplifies data‑management workflows with just one simple call.
Documents
Parameters
- AppRequest.CompressionLevel: The compression level from one to nine (1 to 9)
- 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 Compress API
curl -X 'POST' \ 'https://api.sheetize.cloud/compress' \ -H 'accept: text/plain' \ -H 'Authorization: Bearer TheAccessToken' \ -H 'Content-Type: multipart/form-data' \ -F 'AppRequest.CompressionLevel=2' \ -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.
