Skip to main content
POST
/
v1
/
simulations
Create a simulation
curl --request POST \
  --url https://api.example.com/v1/simulations \
  --header 'Content-Type: application/json' \
  --data '
{
  "mode": "<string>",
  "goal": "<string>",
  "user_model_ids": [
    "<string>"
  ],
  "inputs": {},
  "title": "<string>"
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Headers

​
authorization
string

Body

application/json
​
mode
string
required

'research' or 'journey'

​
goal
string
required

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

​
user_model_ids
string<uuid4>[]
required

One or more user-model ids to simulate against

​
inputs
Inputs · object

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

​
title
string | null

Response

Successful Response