Get a scenario's state, inputs and price
get_scenarioRetrieve a scenario's compact state, including computed status, inputs, cost estimate, and run details. Use it to check build readiness and pricing without fetching raw detail.
Instructions
Get a scenario's COMPACT state: its computed_status, inputs, estimate and price.
Returns a compact record, never the raw ~50 KB detail: scenario_id,
computed_status, mesh_triangle_count_estimate and its _breakdown,
latest_run_is_valid, the latest run's run_id, run_status,
error_message, user_message, status_detail and mesh_triangle_count
— plus what the scenario IS and what it will cost: name, description,
project, resolution, duration, the input row ids (terrain,
boundary, friction, inflow, rainfall, building, mesh_region, culvert),
compute_cost_estimate (USD), vcpu_hours_estimate, and
inflow_anchor_mismatch (null unless an inflow series starts after the
model does: the model gets zero flow from that series over the lead-in
gap before its first sample), and
hydrology_check (when Hydrata sends it: for each inflow and rainfall
feature, the series that drives it, its peak and volume, and structured
warnings — repeat those numbers to the user, never your own), and
unbound_series with a say_to_user warning when the project holds a
rainfall or flow series that no inflow or rainfall feature uses (the model
ignores it: tell the user and ask which input it belongs to).
The computed_status field (there is NO status key on a scenario) is
derived from the latest run and will be one of: created, building, built,
queued, computing, processing, complete, error, or cancelled — created
also means no run exists yet. A scenario must be built before it can be
run. latest_run_is_valid is false after any edit since the last build.
unreviewed_inputs lists the inputs written by an agent key that the user
has not reviewed at their current content (kind, layer_id, title,
feature_count, the grant that wrote it, authored_method (the agent's own account of
how it made the input, when it gave one), reopened when an edit undid an
earlier input review): while it is not empty, build and run are refused
UNREVIEWED_INPUTS. Only the user reviews, in the browser — poll this tool
every 30-60 s after giving them the review link.
A non-member reading a public project's scenario gets a reduced record:
the fields the server withholds (the input ids, the price,
inflow_anchor_mismatch) are ABSENT here rather than reported as null —
"withheld" is not "no terrain, no cost" — while the run-state keys,
computed_status among them, read null.
No presigned S3 URL is returned by any read tool (each is a 6-hour
capability): results stay viewable through a run's gn_layer_* WMS
entries — use get_run for the full run record.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | Yes | The project ID | |
| scenario_id | Yes | The scenario ID |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||