Simulations
Evaluate Simulation Variables
Evaluate specific variables from a simulation.
This endpoint supports lazy variable evaluation:
- If UCPSolution exists in storage: returns variables already in parquet
- If only simulation_data exists and variables are present: returns from database
- If variables are missing: triggers a re-run job (returns 202 Accepted)
Parameters
simulation_id : str ID of the simulation body : EvaluateVariablesRequest Request body with list of variable names to evaluate
Returns
dict Dictionary with time_series, steps, and metrics
Raises
HTTPException 202 if re-run is triggered (includes job_id in detail) 404 if simulation not found
post/simulations/{simulation_id}/evaluate
Path parameters
simulation_idstring required
Query parameters
target_rowsinteger nullable
Maximum rows per returned variable
Maximum rows per returned variable
x_minnumber nullable
Lower x-range bound (inclusive)
Lower x-range bound (inclusive)
x_maxnumber nullable
Upper x-range bound (inclusive)
Upper x-range bound (inclusive)
x_columnstring
Column the window applies to
Column the window applies to
Request body
Response
Successful Response
{"stackTrail":"paths:/simulations/{simulation_id}/evaluate:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}
Changes
No recorded changes to this endpoint across all 1 revision of this API.