Sign in

v1

latestOpenAPI 3.1.02026-07-139517.9 KB
Simulations

Create a simulation

Create a simulation from mode + goal + inputs + user_model_ids.

Returns immediately in status planning; the plan is generated in the background. Poll GET /{id} until status is planned.

post/v1/simulations

Headers

authorizationstring

Request body

modestring required

'research' or 'journey'

goalstring required

Goal id within the mode (from /v1/simulation-schema)

inputsobject

Answers keyed by the goal's input ids (from /v1/simulation-schema)

user_model_idsstring[] required

One or more user-model ids to simulate against

titlestring nullable

Response

Successful Response

{"stackTrail":"paths:/v1/simulations:post:responses:201:content:application/json:schema","oasType":"schema","type":"unknown"}