Skip to main content
POST
Solve Sheet

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Authorization
string
required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

sheetId
string<uuid>
required

Sheet UUID. Accepted in canonical, uppercase, braced, or unhyphenated form, as projectId is on POST /v1/templates/{code}/sheets.

Response

The sheet was solved and has results.

Results of solving the sheet. Re-solving after an input update refreshes results on the same sheet.

sheetId
string<uuid>
required

Unique identifier for the sheet.

status
enum<string>
required

solved when the results below were computed from the inputs the sheet holds now — the normal outcome. unsolved only where another write landed on the sheet while the solve was running, leaving results that no longer match its inputs; solve again to get results for them.

Available options:
solved,
unsolved
passed
boolean | null
required
deprecated

Deprecated: read summaryCheckStatus for the verdict of this solve. passed is not this solve's verdict: a failing calculation can report true, even on its first solve, or null.

results
object
required

Solved outputs, keyed by the reference IDs the template schema lists in outputs[]. A given solve returns the subset of those that apply to the inputs you sent.

sheetUrl
string<uri>
required

Link to the sheet in the Calcs.com app.

projectId
string<uuid>

Project the sheet belongs to.

summaryCheck

Value of the template's governing check for this solve. Absent when the check could not be evaluated (summaryCheckStatus is error). A template that defines no governing check reports true here, so read the verdict from summaryCheckStatus, which tells the two apart (not_evaluated).

summaryCheckReferenceId
string

Reference ID of the widget summaryCheck came from.

summaryCheckError
boolean

Whether the governing check could not be evaluated. A check in error has no verdict, whatever summaryCheck holds.

summaryCheckFailReasons
string[]

Why the governing check failed, when it did.

summaryCheckStatus
enum<string>

Verdict of the template's governing check for this solve. pass: the check passed (summaryCheck is true, or a number from 0 to 1). fail: the check evaluated and failed (false, or a number outside 0 to 1). error: the check could not be evaluated — summaryCheckError is true, or the solve produced no value for a check the template defines; treat it as not passing. not_evaluated: the template defines no governing check.

Available options:
pass,
fail,
error,
not_evaluated