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>"
}
'import requests
url = "https://api.example.com/v1/simulations"
payload = {
"mode": "<string>",
"goal": "<string>",
"user_model_ids": ["<string>"],
"inputs": {},
"title": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
mode: '<string>',
goal: '<string>',
user_model_ids: ['<string>'],
inputs: {},
title: '<string>'
})
};
fetch('https://api.example.com/v1/simulations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/simulations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'mode' => '<string>',
'goal' => '<string>',
'user_model_ids' => [
'<string>'
],
'inputs' => [
],
'title' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/simulations"
payload := strings.NewReader("{\n \"mode\": \"<string>\",\n \"goal\": \"<string>\",\n \"user_model_ids\": [\n \"<string>\"\n ],\n \"inputs\": {},\n \"title\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/simulations")
.header("Content-Type", "application/json")
.body("{\n \"mode\": \"<string>\",\n \"goal\": \"<string>\",\n \"user_model_ids\": [\n \"<string>\"\n ],\n \"inputs\": {},\n \"title\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/simulations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"mode\": \"<string>\",\n \"goal\": \"<string>\",\n \"user_model_ids\": [\n \"<string>\"\n ],\n \"inputs\": {},\n \"title\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}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 / until status is planned.
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>"
}
'import requests
url = "https://api.example.com/v1/simulations"
payload = {
"mode": "<string>",
"goal": "<string>",
"user_model_ids": ["<string>"],
"inputs": {},
"title": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
mode: '<string>',
goal: '<string>',
user_model_ids: ['<string>'],
inputs: {},
title: '<string>'
})
};
fetch('https://api.example.com/v1/simulations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/simulations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'mode' => '<string>',
'goal' => '<string>',
'user_model_ids' => [
'<string>'
],
'inputs' => [
],
'title' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/simulations"
payload := strings.NewReader("{\n \"mode\": \"<string>\",\n \"goal\": \"<string>\",\n \"user_model_ids\": [\n \"<string>\"\n ],\n \"inputs\": {},\n \"title\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/simulations")
.header("Content-Type", "application/json")
.body("{\n \"mode\": \"<string>\",\n \"goal\": \"<string>\",\n \"user_model_ids\": [\n \"<string>\"\n ],\n \"inputs\": {},\n \"title\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/simulations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"mode\": \"<string>\",\n \"goal\": \"<string>\",\n \"user_model_ids\": [\n \"<string>\"\n ],\n \"inputs\": {},\n \"title\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Headers
Body
application/json
'research' or 'journey'
Goal id within the mode (from /v1/simulation-schema)
One or more user-model ids to simulate against
Answers keyed by the goal's input ids (from /v1/simulation-schema)
Response
Successful Response
⌘I