Documentation sections
Batch
POSThttps://rftools.io/
Up to 50 calculations in one request, any mix of calculators: a parameter sweep, or a design's figures together. Each item is computed exactly as /calculate computes it.
The batch endpoint is part of the API plan. Each item computed counts as one call; an item refused before it is computed costs nothing.
Request body
| Field | Description |
|---|---|
| calculationsrequiredarray | 1 to 50 items, each {slug, inputs} as /calculate takes them. More is refused with 400 and the limit. |
Response
| Field | Description |
|---|---|
| resultsarray | One item per calculation, in order. |
| results[].slugstring | The item's calculator. |
| results[].values, warnings, errors, provenanceas /calculate | A computed item: exactly what /calculate returns for it. |
| results[].error, errorKindstring | An item that was not computed: why (an unknown slug, an input that is not a finite number). It was not counted. |
The results are in the order of the request. Check each item: a computed one has values and provenance; one that was not has error and errorKind. A failure in one item never fails the others.
Refusals
400: no calculations (At least one calculation is required), or more than 50, with the limit.401: no key, or a key that is not valid.402: the allowance cannot cover the items to compute; nothing was counted.403: the account's plan has no batch access; the body names the plan that has it.