Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Monitor and control a running simulation

Use the simulation ID returned at submission to inspect a run, consume live residuals, or stop it before its configured timeout.

The commands below assume VANELLUS_API_KEY and simulation_id are already set.

Check one run or list active runs

Read the current status of one simulation:

# Show lifecycle state, iteration count, runtime, and any error.
curl --fail-with-body --silent --show-error \
  -H "X-API-Key: $VANELLUS_API_KEY" \
  "https://api.vanellus.tech/simulations/$simulation_id/status" | jq .

List all of your currently running simulations when the ID is not known or several jobs are being coordinated:

# Return status documents for every active simulation owned by this API key.
curl --fail-with-body --silent --show-error \
  -H "X-API-Key: $VANELLUS_API_KEY" \
  "https://api.vanellus.tech/simulations/get_running" | jq .

Treat completed as the indication that persisted results can be downloaded. Interpret status to decide whether the outcome is acceptable for the workflow.

Follow live residuals

Progress updates are recorded automatically. Connect to the Server-Sent Events stream after submitting the request:

# Keep curl's output unbuffered so each JSON event is visible when it arrives.
curl --no-buffer --fail-with-body --silent --show-error \
  -H "X-API-Key: $VANELLUS_API_KEY" \
  "https://api.vanellus.tech/simulations/$simulation_id/progress_stream"

Each event contains the SIMPLE iteration and current residual, monitor, and junction-temperature values. The stream ends after the run reaches a terminal state and pending updates have been delivered.

Cancel or kill the run

Request graceful cancellation when the current iteration can be allowed to finish:

# Preserve the partial result by stopping after the current solver iteration.
curl --fail-with-body --silent --show-error -X POST \
  -H "X-API-Key: $VANELLUS_API_KEY" \
  "https://api.vanellus.tech/simulations/$simulation_id/cancel" | jq .

The canceled run retains downloadable results. If the current iteration is stuck or must stop immediately, kill it instead:

# Stop immediately; a killed run has no downloadable result bundle.
curl --fail-with-body --silent --show-error -X POST \
  -H "X-API-Key: $VANELLUS_API_KEY" \
  "https://api.vanellus.tech/simulations/$simulation_id/kill" | jq .

Set timeout_cancel and timeout_kill in the original request to apply the same graceful-then-immediate policy automatically. Leave enough time between them for the current iteration to finish; if the kill timeout comes first, the server proceeds directly to the hard stop.

See also