Platform APISimulations

Start a simulation

Start a new simulation using a simulation case.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
simulation_case_idstringRequiredformat: "uuid"
target_agent_idstringRequiredformat: "uuid"
simulation_session_idstring or nullOptionalformat: "uuid"
custom_variablesmap from strings to anyOptional

Response

200
statusstring or null
Whether the request was successful.
responseobject or null
Simulation details.

Errors