Export the workbook
Updated 2026-11-13
The four ways to get a workbook out of SpreadAPI: as an Excel file, as a service package, as a runtime package, and as a filled-in Excel file for the callers of your service.
Overview
| Export | What you get | Use it to |
|---|---|---|
| Export to Excel (Als Excel exportieren) | An .xlsx file of the workbook | Continue working in Excel, or keep a copy. |
| Export Service Package (Service-Paket exportieren) | A .json file with the workbook and the whole service configuration | Back up a service or copy it into another service. |
| Export for Runtime (Für Runtime exportieren) | A .json runtime package | Run the service on your own infrastructure with the SpreadAPI Runtime. |
| Allow Excel export (Excel-Export erlauben) | A download link for callers | Let callers download the workbook filled with their input values. |
The first three are in the three-dots menu (⋮) at the right end of the header of the service page. They need the workbook to be loaded, so open the Configuration (Konfiguration) tab first.
Export to Excel
- Open the service on the Configuration tab.
- Open the three-dots menu (⋮) and choose Export to Excel.
- The browser downloads a file named after the service and today's date, for example
Loan calculator_2026-11-13.xlsx.
The file holds the workbook as it is in the editor at that moment, including changes you have not saved yet, with all sheets, formulas and formatting. Your inputs, outputs and settings are not part of an Excel file.
To bring an edited file back, use Import from Excel; see Replace the workbook.
Export a service package
A service package is one file that holds everything that defines the service: the workbook, the inputs and outputs with their rules and descriptions, AI areas, the AI descriptions, and the service and app settings.
- Open the three-dots menu (⋮) and choose Export Service Package.
- The browser downloads
<service name>_package.json.
To use a package, create a new service and click Import an existing Service Package (Service-Paket importieren) at the bottom of the empty Configuration tab. Choose the .json file, wait for Service package imported successfully! Remember to save your changes., then click Save (Speichern). The new service is a draft with its own address; publish it when it is ready.
API tokens are not part of a package. Create new tokens for the new service; see Tokens and access.
A package contains your workbook with all its formulas. Store and share it as carefully as the Excel file itself.
Export for the runtime
The SpreadAPI Runtime runs services on your own servers. Export for Runtime creates the file the runtime loads.
- Open the three-dots menu (⋮) and choose Export for Runtime.
- The dialog Publish via Runtime Package (Über Runtime-Paket veröffentlichen) explains the steps. Click Export Runtime Package (Runtime-Paket exportieren).
- The browser downloads
<service name>_runtime.json. - Upload the file to your SpreadAPI Runtime.
The runtime package holds the workbook and the definition of the inputs and outputs. What the runtime is and how to get it is described in On-premises.
Let callers export results to Excel
With this option a caller gets, next to the calculated outputs, a link that downloads the workbook as an .xlsx file, filled with the caller's input values and recalculated.
- Click the settings button in the header to open Settings (Einstellungen).
- In the section General (Allgemein), switch on Allow Excel export.
- Click Save, then publish again.
From then on:
- Every answer of the API carries a download link in
metadata.exportUrl; see The API response. - AI assistants connected to the service receive the same link with a result and can offer it to their user.
The downloaded file contains the whole workbook, formulas included. Callers of a service normally never see the workbook or its formulas. Switch this option on only if your callers may see them.
The option is off unless you switch it on. All settings are described in Service settings.
For developers and agents
The export for callers is a GET address next to the one for calculations:
GET https://spreadapi.io/api/v1/services/{serviceId}/export?amount=20000&rate=0.05- Inputs are query parameters, as in a GET call to
/execute. They are checked by the same rules; see Input validation. _filenamesets the name of the downloaded file. Without it the file is named after the service, followed by the date.- The answer is the
.xlsxfile as a download. - A token-protected service needs its token, as
?token=or asAuthorization: Bearer <token>. The link inmetadata.exportUrlof such a service is made for exactly the input values of that call and stops working after 24 hours. - Exports count towards the limit of 1,000 calls per minute per service.
| Status | Meaning |
|---|---|
| 200 | The file. |
| 400 | An input is missing or was refused; the body says which. |
| 401 | The service is protected and the token is missing or not valid. |
| 403 | Excel export is not enabled for this service. |
| 404 | The service does not exist or is not published. |
| 429 | Too many calls in a minute. |
FAQ
How do I download my workbook as an Excel file?
On the Configuration tab, open the three-dots menu (⋮) in the header and choose Export to Excel. The browser downloads an .xlsx file with all sheets, formulas and formatting.
What is a service package?
A .json file that holds the workbook together with the service's inputs, outputs, AI areas, descriptions and settings. You use it to back up a service or to create a copy by importing it into a new service.
How do I back up a service?
Choose Export Service Package in the three-dots menu and keep the downloaded file. To restore it, create a new service and click Import an existing Service Package on the empty Configuration tab.
How do I copy a service to another account?
Export a service package, sign in to the other account, create a new service there and import the package. Then save, create new tokens if the service is protected, and publish.
Does "Export to Excel" include my inputs and outputs?
No. An Excel file holds the workbook only. To take the parameters and settings along, export a service package.
What is "Export for Runtime" for?
It creates the package for the SpreadAPI Runtime, which runs services on your own infrastructure. See On-premises.
Can callers of my API download the result as an Excel file?
Yes, if you switch on Allow Excel export under Settings → General, save and publish again. Each answer then carries a download link in metadata.exportUrl.
Do callers see my formulas when Excel export is on?
Yes. The downloaded file is the whole workbook with its formulas. Leave the option off if the formulas must stay private.
Why is "Export Service Package" greyed out?
The export needs the loaded workbook. Open the Configuration tab, wait for the workbook to appear, and open the menu again.
As an agent, how do I give my user the Excel file of a result?
Read metadata.exportUrl from the answer of the calculation and pass that link to the user. It is present only when the service owner allowed Excel export.