Calculators - Generic

Total number of templates available to this API key, independent of limit and offset. More pages remain while offset plus the number of entries in templates is less than total.

The limit applied to this page.

The offset applied to this page.

Identifier of the currently published template version; changes when the template is republished — use code as the stable identifier

The template version that will serve calculations and sheet creates; null when the template records no version

Template code

Human-readable template name

Template category

Brief description of the template; null when the template provides none

Input field definitions for the template

The maximum set a calculate call can return, one entry per output, keyed by referenceId in the results object. Any one calculation carries a subset: outputs can be conditional on inputs, and some kinds (for example gis and customdiagram) are described here but not returned. An output that is also settable appears in fields[] and outputs[], and in both inputs and results, holding the stored value in one and the solved value in the other.

Available presets for the template

Non-fatal warnings (e.g., deprecated fields)

Unique identifier for the created calculation sheet

The project the sheet was created in.

Direct link to the sheet in the ClearCalcs web app. Always present on a successful response.

Template code that was used

Echo of the resolved values the calculation ran with — one entry per settable field, keyed by the same referenceIds as fields[] in GET /v1/templates/{code}. Values are echoed in stored form: numbers as strings, enum choices as their stored value or row index, table fields as row arrays.

Calculation results keyed by referenceId. The keys come from the template schema's outputs[] (GET /v1/templates/{code}), and a given calculation returns the subset of those that apply to the inputs you sent. Value shape depends on the output kind: numbers, booleans, strings (including multi-sentence guidance text), and arrays of row objects, which may be empty. Numeric values are returned unrounded.

Whether the calculation's checks passed; null when the template defines no pass/fail checks

Value of the template's governing summary check — a pass/fail boolean or a numeric utilisation, depending on the template. Present when the template defines one.

referenceId of the governing check. Present with summaryCheck.

True when the summary check could not be evaluated. Present when the template defines a summary check.

Reasons the summary check failed. Present only on failure.

Non-blocking validation warnings, present when any were raised. Unrecognised attribute names are returned as a 422 instead.

Identifier to poll.

Always bulk-calculate.

processing while sheets are being created and solved. completed once every item has an outcome; items that could not be solved carry their own error, so a completed batch can have summary.solved of 0. failed when the batch itself could not run, or when it stopped before finishing and will not resume (see error). Treat an unrecognised value as still in progress.

Whole-number share of the batch's own sheets solved so far, 0 to 100, while processing. Set to 100 when the batch reaches completed, whatever summary.solved is; read summary for the outcome. Frozen where it stopped when failed.

Number of items requested.

Counts over the items. pending is total - solved - errored - stale and is 0 once the batch is terminal, where every item is solved or carries an error. The three non-solved counters answer different questions and are never folded together, because the remedy differs: errored counts items the batch could not produce results for, where retrying is the fix; stale counts items it did solve whose inputs have changed since, where nothing failed and re-solving the sheet is the fix; checkErrored counts items that solved but whose governing check produced no verdict, and those are also counted in solved. To confirm every item is usable, check errored, stale and checkErrored are all 0. state is the completion signal. While processing the counts are progress, and pending can read 0 in the moments between the last sheet solving and the batch reaching a terminal state; do not use it to detect completion. On a terminal batch the counters are recomputed from the sheets' current state on every poll, so the same batchId can report different counts later if its sheets are edited or deleted.

null until the batch is terminal.

How long the batch took. Set when the batch reached a terminal state and the duration was recorded; null otherwise. A batch the worker had to mark failed as a last resort can be failed with durationSeconds null.

Why the batch itself failed. Set when the batch failed and the reason was recorded; null otherwise. A batch the worker had to mark failed as a last resort can be failed with error null.

One entry per requested item, in request order. null until the batch is terminal.

Identifier to poll.

Always bulk-calculate.

processing while sheets are being created and solved. completed once every item has an outcome; items that could not be solved carry their own error, so a completed batch can have summary.solved of 0. failed when the batch itself could not run, or when it stopped before finishing and will not resume (see error). Treat an unrecognised value as still in progress.

Whole-number share of the batch's own sheets solved so far, 0 to 100, while processing. Set to 100 when the batch reaches completed, whatever summary.solved is; read summary for the outcome. Frozen where it stopped when failed.

Number of items requested.

Counts over the items. pending is total - solved - errored - stale and is 0 once the batch is terminal, where every item is solved or carries an error. The three non-solved counters answer different questions and are never folded together, because the remedy differs: errored counts items the batch could not produce results for, where retrying is the fix; stale counts items it did solve whose inputs have changed since, where nothing failed and re-solving the sheet is the fix; checkErrored counts items that solved but whose governing check produced no verdict, and those are also counted in solved. To confirm every item is usable, check errored, stale and checkErrored are all 0. state is the completion signal. While processing the counts are progress, and pending can read 0 in the moments between the last sheet solving and the batch reaching a terminal state; do not use it to detect completion. On a terminal batch the counters are recomputed from the sheets' current state on every poll, so the same batchId can report different counts later if its sheets are edited or deleted.

null until the batch is terminal.

How long the batch took. Set when the batch reached a terminal state and the duration was recorded; null otherwise. A batch the worker had to mark failed as a last resort can be failed with durationSeconds null.

Why the batch itself failed. Set when the batch failed and the reason was recorded; null otherwise. A batch the worker had to mark failed as a last resort can be failed with error null.

One entry per requested item, in request order. null until the batch is terminal.