Server REST API //simulator
POST

/simulator

5 endpoints
get_step_contextget_simulation_configis_runningrequest_terminatereset
POST/simulator/get_step_context
get_step_context
Request Body
FieldTypeDescription
—objectEmpty object
Response200 OK
FieldTypeDescription
successboolWhether the call succeeded
msgstringStatus or error message
dataobjectPayload; shape depends on the endpoint
Request bodyJSON
{}
Response200 OK
{
  "success": true,
  "msg": "ok",
  "data": {
    "step": 120,
    "dt": 0.0166667
  }
}
POST/simulator/get_simulation_config
get_simulation_config
Request Body
FieldTypeDescription
—objectEmpty object
Response200 OK
FieldTypeDescription
successboolWhether the call succeeded
msgstringStatus or error message
dataobjectPayload; shape depends on the endpoint
Request bodyJSON
{}
Response200 OK
{
  "success": true,
  "msg": "ok",
  "data": {
    "stereotype": "isaaclab",
    "dt": 0.0166667,
    "initialize_steps": 30
  }
}
POST/simulator/is_running
is_running
Request Body
FieldTypeDescription
—objectEmpty object
Response200 OK
FieldTypeDescription
successboolWhether the call succeeded
msgstringStatus or error message
databoolPayload; shape depends on the endpoint
Request bodyJSON
{}
Response200 OK
{
  "success": true,
  "msg": "ok",
  "data": true
}
POST/simulator/request_terminate
request_terminate
Request Body
FieldTypeDescription
—objectEmpty object
Response200 OK
FieldTypeDescription
successboolWhether the call succeeded
msgstringStatus or error message
datanullPayload; shape depends on the endpoint
Request bodyJSON
{}
Response200 OK
{
  "success": true,
  "msg": "Termination requested",
  "data": null
}
POST/simulator/reset
reset
Request Body
FieldTypeDescription
—objectEmpty object
Response200 OK
FieldTypeDescription
successboolWhether the call succeeded
msgstringStatus or error message
datanullPayload; shape depends on the endpoint
Request bodyJSON
{}
Response200 OK
{
  "success": true,
  "msg": "Simulation reset",
  "data": null
}