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.

With project_id it joins round_id, or the project's latest round. Refused with 409 while the in-app planner is mid-turn on that project.

post/v1/simulations

Request

  • Base URL: https://api.semilattice.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.semilattice.ai/v1/simulations
  • Auth: none declared

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
project_idstring uuid nullable

Optional project to add this simulation to; it joins the project's latest round (round 1 is created if none exists)

context_idstring uuid nullable

Context to plan against (from /v1/contexts). Defaults to your most recently updated context, else your organisation's. A simulation in a project plans against the project's context, so leave this out when passing project_id unless it names that same context.

round_idstring uuid nullable

Round of project_id to put this simulation in. Defaults to the project's latest round.

Response

Successful Response

unknown required

Changes

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