SpreadAPI icon

SpreadAPI

Run spreadsheet calculations with SpreadAPI

Actions2

Calculate

AI-generated

Summary

Execute a published SpreadAPI calculation service with custom input values, returning calculated outputs.

Inputs

  • service (required) — Select a service from the credential's list, or provide its URL/ID directly.
  • specifyInputs (required) — Choose how to provide inputs: 'Using Fields Below' (maps dynamically from the service) or 'Using JSON' (manual object).
  • inputs (required) — Map input parameters dynamically when using 'Using Fields Below'. Available fields are fetched from the selected service.
  • inputsJson (required) — Provide all input values as a single JSON object when using 'Using JSON'. Percentages should be passed as decimals (e.g., 0.05 for 5%).
  • options — Set 'Bypass Cache' to force a fresh calculation. Set 'Simplify Output' to return results as a flat object instead of the raw API response array.

Output shape

a list of items, each containing calculated outputs in '' (either a flat object or the raw array from the API, depending on 'Simplify Output').

If 'Simplify Output' is disabled, the output is a flat object keyed by the name of each calculated field. When enabled, the output is a flat object directly mapping each calculated field to its value.

Examples

Example 1: Calculate mortgage payments with a dynamic service

Select service 'mortgage-calc-a1b2c3' from the list. Use 'Using Fields Below' to map 'amount' and 'rate' dynamically fetched from the service definition.

Example 2: Force a fresh calculation and keep raw API response

Select service by URL 'https://spreadapi.io/d/mortgage-calc-a1b2c3'. Use 'Using JSON' with {"amount": 300000, "rate": 0.05}. Enable 'Bypass Cache' and disable 'Simplify Output'.

Links

Discussion