{"data":{"markdownRemark":{"html":"

POST

\n

Creates and runs a model sampler simulation and returns the object with its various attributes.

\n

Request

\n

Example request body

\n
curl -X POST \\\n  http://localhost:8080/api/simulations/model-sampler \\\n  -H 'Cache-Control: no-cache' \\\n  -H 'Content-Type: application/json' \\\n  -d '{\n  \"modelName\": \"Simple Credit Card\",\n  \"outputPath\":\"/tmp/sampler\",\n  \"modelSampler\": {\n      \"dimensions\": {\n        \"interest\":[0.01,0.02,0.03],\n        \"spending\":{\n          \"min\":100,\n          \"max\":500\n          }\n      },\n      \"seeds\":[123456, 987645],\n      \"nbSamples\":3,\n      \"nbTicks\":5\n  }\n}'
\n
\n

Windows user File

\n Characters need to be escaped when using model sampler in windows on cmd.\n

'{"name": "Game of Life"}' must become '{\\"name\\": \\"Game of Life\\"}'

\n
\n

Body Schema

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterTypeRequiredDescription
modelNamestringtrueName of model to run a model sampler for
outputPathStringtrueWhere to output the model sampler data.
modelSamplerobjecttrueParameters of the model sampler
>dimensionsobjecttrueThe dimensions that will be used for parameters sampling. The name should correspond the model inner parameters.
>seedsarrayThe seeds used for the runs. The size of the array determine the number of runs.
>mcCountIntegerThe number of Monte-Carlo run per sample.
>nbTicksIntegertrueHow long to run each simulation of the model sampler for
>nbSamplesLongtrueThe number of samples to create from the dimensions values.
\n
\n

The parameters mcCount and seeds both represents the number of run per sample. However, mcCount offer no control over the seeds generation.\nThe seeds will be generated using an internal prng. If you wish to control the specific seeds used, then provide the SDK with the seeds parameter.

\n

Only one should be provided. If both are provided but mcCount does not match seeds' size, an error will be thrown.

\n
\n

Example request body with inline definition for the model sampler

\n
{\n  \"modelName\": \"Simple Credit Card\",\n  \"outputPath\":\"/tmp/sampler\",\n  \"modelSampler\": {\n      \"dimensions\": {\n        \"interest\":[0.01,0.02,0.03],\n        \"spending\":{\n          \"min\":100,\n          \"max\":500\n        }\n      },\n      \"seeds\":[123456, 987645],\n      \"nbSamples\":3,\n      \"nbTicks\":5\n  }\n}
\n

Example of a request body with model sampler definition from input

\n
{\n  \"modelName\": \"Simple Credit Card\",\n  \"outputPath\":\"/tmp/sampler\",\n  \"modelSampler\": \"path/to/input.json\"\n}
\n

The content of input.json should be the same as the one given in the inline definition.

\n

Dimensions input format

\n

\nThe input for a dimension can either be:\n

\n\n

When using bounded range, the current method for parameters sampling will be a Latin Hypercube Sampler.

\n

When using arrays of values as inputs, the parameters sets will be built in an iterative manner. As an example, with the following inputs:

\n
{\n    \"interest\":[0.01,0.02,0.03],\n    \"spending\":[100,200,300]\n}
\n

The resulting parameters sets for the model would be:

\n
{\n    \"1\": {\n      \"interest\": 0.1,\n      \"spending\": 100\n    },\n    \"2\": {\n      \"interest\": 0.2,\n      \"spending\": 200\n    },\n    \"3\": {\n      \"interest\": 0.3,\n      \"spending\": 300\n    }\n}
\n

\n
\nWhen working with Spark multi-run, the model sampler file should be on HDFS. Consequentely the path should start with: \"hdfs://[...]\".\n
\n

Response

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
StatusMeaningDescription
200OKSuccessfully created. The session ID is returned in a cookie named simudyneSessionID. You need to include this cookie in subsequent get requests.
404Not FoundSimulation not found.
\n

Response Schema

\n

Status Code 200

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
idstring(uuid)true
namestringtrue
descriptionstringtrue
publicbooleantrue
sessionstring(uuid)truesimudyneSessionID cookie
kindstringtrue
\n

Example 200 response body

\n
{\n  \"id\": \"d7558ad9-3405-4a4c-972a-531a87fdcd27\",\n  \"name\": \"Game of Life\",\n  \"description\":\n    \"The Game of Life, also known simply as Life, is a cellular automaton devised by the British mathematician John Horton Conway in 1970.\",\n  \"public\": false,\n  \"session\": \"760b2d3e-20b2-42e6-9655-58e662e79e73\",\n  \"kind\": \"pojo\"\n}
\n
\n

Status Code 404

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequired
messagestringtrue
\n

Example 404 response body

\n
{\n    \"message\": \"SimulationRegistry: Could not find requested simulation default.\"\n}
","headings":[{"value":"POST","depth":1},{"value":"Request","depth":2},{"value":"Body Schema","depth":3},{"value":"Dimensions input format","depth":3},{"value":"Response","depth":2},{"value":"Response Schema","depth":3}],"frontmatter":{"title":"/api/simulations/model-sampler","toc":null,"experimental":null}},"site":{"siteMetadata":{"title":"Simudyne Docs","latestVersion":"2.6"}}},"pageContext":{"absolutePath":"/home/vsts/work/1/s/content/2.2/rest_api/model_sampler/api_simulations_model-sampler.md","versioned":true,"version":"2.2","kind":"rest_api","pagePath":"/rest_api/model_sampler/api_simulations_model-sampler","chronology":{"prev":{"name":"Model sampler Rest API","path":"/rest_api/model_sampler"},"next":{"name":"/api/simulations/model-sampler/{id}","path":"/rest_api/model_sampler/api_simulations_model-sampler_id"}},"lastUpdated":"2026-04-21T13:56:54.839Z"}}