v1
simulations

Cancel Simulation V1

post/v1/simulations/{public_id}/cancel

Request

  • Base URL: https://thrustlab.com
  • URL: https://thrustlab.com/v1/simulations/{public_id}/cancel
  • Auth: HTTP bearer

Path parameters

public_idstring required

Request body

SimulationCancelBody required

Response

Successful Response

analysis_typestring required
battery_component_idstring required
battery_topologyobject nullable
completed_atstring nullable

When the run reached a terminal state — completed, failed or canceled. Null until then.

created_atstring nullable

When the run was submitted.

credits_costinteger required
dispatched_atstring nullable

When the run was handed to the worker queue. Null while it is parked and has never been dispatched. NOT the start of execution: a run submitted with launch_intent=run is dispatched at submit, so this can equal created_at while the run waits for a slot.

display_labelsobject nullable
errorobject nullable required
idstring required
input_snapshotobject nullable
is_starredboolean required
namestring nullable required
object'simulation' required
plot_config_jsonobject[] nullable required
progressnumber nullable required
project_idstring required
project_namestring nullable
propeller_modelstring
resultobject nullable required
snapshot_versioninteger
solver_enginestring
started_atstring nullable

When a worker claimed the run and the solve began. Null until then. started_at - dispatched_at is the time spent waiting for a slot; completed_at - started_at is the solve itself.

status'draft' | 'queued' | 'running' | 'completed' | 'failed' | 'canceled' required

Changes

No recorded changes to this operation across all 1 revision of this API.