Request Model Check
request_model_checkRequest a model check of the obligations the behavioural analysis could not settle. Mutating only with confirm_estimate=True; a paid action then.
Instructions
Request a model check of the obligations the behavioural analysis
could not settle. Mutating only with confirm_estimate=True; a paid
action then.
A check is paid for by whoever requests it, so it is estimated first and the estimate is RELAYED TO THE PERSON before it is confirmed. Never confirm on your own.
Call with
confirm_estimate=False(the default): nothing runs or is charged. The answer carries theobligationsit would cover (each with its completionprediction), thescope, thecones(each module, its runs, andremedies/not_runwhere it may not complete or fits no runner), theestimate, themodel_versionandset_revisionthe model stands at, andnoticeson what a check does. Show all of it to the person. With nothing to check, themessagesays so: nameobligationsto check some anyway.Once they agree, call with
confirm_estimate=Trueand those two values. The check is queued (confirmed: true,job_id,status: "queued"); pollget_model_checkuntilterminal.
Refusals come back as data, {confirmed: false, http_status, code, message}: 409 not_confirmed (confirm the behavioural model first,
after reviewing it), differences_open (answer the open questions an
earlier check raised), check_active (one is live: read it),
generation_active (a build holds the model), review_stale (the
model or its controls changed since the estimate: confirm again with
the values returned), no_runner_size (every module is larger than
any runner holds: answer the defaults it rests on, or narrow the scope
or the obligations); 503 not_priced or no_runner_pool (checks
cannot run here yet); 402 (the balance cannot cover the estimate). A 404
means model checks are not available for the model, or the caller may
not start paid actions on it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| scope | No | Optional JSON object lowering some of the scope's constants, the keys the estimate's ``scope`` reports (e.g. ``{"domain": 1, "horizon": 4}``); each must be a non-negative integer at most the declared value, and those left out keep it (400 ``bad_scope`` otherwise). | |
| model_id | Yes | ID of the threat model. | |
| obligations | No | Optional comma-separated obligation ids to cover in place of the default (the unsettled ones the controls' groups reach). | |
| set_revision | No | With ``confirm_estimate=True``: the estimate's value. | |
| model_version | No | With ``confirm_estimate=True``: the estimate's value. | |
| server_version | Yes | ||
| confirm_estimate | No | False (default) estimates; True queues the check. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||