Skip to main content
POST
/
v1
/
test-runs
/
simulations
Trigger simulation test run
curl --request POST \
  --url https://api.getmaxim.ai/v1/test-runs/simulations \
  --header 'Content-Type: application/json' \
  --header 'x-maxim-api-key: <api-key>' \
  --data '
{
  "workspaceId": "<string>",
  "entityId": "<string>",
  "datasetId": "<string>",
  "simulationType": "PROMPT_SIMULATION",
  "simulationConfig": {
    "type": "MAXIM",
    "maxTurns": 2,
    "persona": "<string>",
    "tools": [
      "<string>"
    ],
    "context": {
      "type": "CONTEXT_SOURCE",
      "payload": "<string>"
    }
  },
  "datasetSplitId": "<string>",
  "evaluators": [
    {
      "id": "<string>",
      "variableMapping": {}
    }
  ],
  "contextToEvaluate": [
    {
      "payload": "<string>"
    }
  ]
}
'
import requests

url = "https://api.getmaxim.ai/v1/test-runs/simulations"

payload = {
    "workspaceId": "<string>",
    "entityId": "<string>",
    "datasetId": "<string>",
    "simulationType": "PROMPT_SIMULATION",
    "simulationConfig": {
        "type": "MAXIM",
        "maxTurns": 2,
        "persona": "<string>",
        "tools": ["<string>"],
        "context": {
            "type": "CONTEXT_SOURCE",
            "payload": "<string>"
        }
    },
    "datasetSplitId": "<string>",
    "evaluators": [
        {
            "id": "<string>",
            "variableMapping": {}
        }
    ],
    "contextToEvaluate": [{ "payload": "<string>" }]
}
headers = {
    "x-maxim-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'x-maxim-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    workspaceId: '<string>',
    entityId: '<string>',
    datasetId: '<string>',
    simulationType: 'PROMPT_SIMULATION',
    simulationConfig: {
      type: 'MAXIM',
      maxTurns: 2,
      persona: '<string>',
      tools: ['<string>'],
      context: {type: 'CONTEXT_SOURCE', payload: '<string>'}
    },
    datasetSplitId: '<string>',
    evaluators: [{id: '<string>', variableMapping: {}}],
    contextToEvaluate: [{payload: '<string>'}]
  })
};

fetch('https://api.getmaxim.ai/v1/test-runs/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.getmaxim.ai/v1/test-runs/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([
    'workspaceId' => '<string>',
    'entityId' => '<string>',
    'datasetId' => '<string>',
    'simulationType' => 'PROMPT_SIMULATION',
    'simulationConfig' => [
        'type' => 'MAXIM',
        'maxTurns' => 2,
        'persona' => '<string>',
        'tools' => [
                '<string>'
        ],
        'context' => [
                'type' => 'CONTEXT_SOURCE',
                'payload' => '<string>'
        ]
    ],
    'datasetSplitId' => '<string>',
    'evaluators' => [
        [
                'id' => '<string>',
                'variableMapping' => [
                                
                ]
        ]
    ],
    'contextToEvaluate' => [
        [
                'payload' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-maxim-api-key: <api-key>"
  ],
]);

$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.getmaxim.ai/v1/test-runs/simulations"

	payload := strings.NewReader("{\n  \"workspaceId\": \"<string>\",\n  \"entityId\": \"<string>\",\n  \"datasetId\": \"<string>\",\n  \"simulationType\": \"PROMPT_SIMULATION\",\n  \"simulationConfig\": {\n    \"type\": \"MAXIM\",\n    \"maxTurns\": 2,\n    \"persona\": \"<string>\",\n    \"tools\": [\n      \"<string>\"\n    ],\n    \"context\": {\n      \"type\": \"CONTEXT_SOURCE\",\n      \"payload\": \"<string>\"\n    }\n  },\n  \"datasetSplitId\": \"<string>\",\n  \"evaluators\": [\n    {\n      \"id\": \"<string>\",\n      \"variableMapping\": {}\n    }\n  ],\n  \"contextToEvaluate\": [\n    {\n      \"payload\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-maxim-api-key", "<api-key>")
	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.getmaxim.ai/v1/test-runs/simulations")
  .header("x-maxim-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workspaceId\": \"<string>\",\n  \"entityId\": \"<string>\",\n  \"datasetId\": \"<string>\",\n  \"simulationType\": \"PROMPT_SIMULATION\",\n  \"simulationConfig\": {\n    \"type\": \"MAXIM\",\n    \"maxTurns\": 2,\n    \"persona\": \"<string>\",\n    \"tools\": [\n      \"<string>\"\n    ],\n    \"context\": {\n      \"type\": \"CONTEXT_SOURCE\",\n      \"payload\": \"<string>\"\n    }\n  },\n  \"datasetSplitId\": \"<string>\",\n  \"evaluators\": [\n    {\n      \"id\": \"<string>\",\n      \"variableMapping\": {}\n    }\n  ],\n  \"contextToEvaluate\": [\n    {\n      \"payload\": \"<string>\"\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.getmaxim.ai/v1/test-runs/simulations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-maxim-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workspaceId\": \"<string>\",\n  \"entityId\": \"<string>\",\n  \"datasetId\": \"<string>\",\n  \"simulationType\": \"PROMPT_SIMULATION\",\n  \"simulationConfig\": {\n    \"type\": \"MAXIM\",\n    \"maxTurns\": 2,\n    \"persona\": \"<string>\",\n    \"tools\": [\n      \"<string>\"\n    ],\n    \"context\": {\n      \"type\": \"CONTEXT_SOURCE\",\n      \"payload\": \"<string>\"\n    }\n  },\n  \"datasetSplitId\": \"<string>\",\n  \"evaluators\": [\n    {\n      \"id\": \"<string>\",\n      \"variableMapping\": {}\n    }\n  ],\n  \"contextToEvaluate\": [\n    {\n      \"payload\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": "<string>",
    "workspaceId": "<string>",
    "status": "<string>",
    "entityType": "<string>",
    "createdAt": "<string>",
    "entityId": "<string>"
  }
}

Authorizations

​
x-maxim-api-key
string
header
required

API key for authentication

Body

application/json

Payload for triggering a simulation test run

​
workspaceId
string
required

Workspace ID where the simulation will run

​
entityId
string
required

ID of the entity to simulate (prompt version ID, workflow ID)

​
datasetId
string
required

Dataset ID to use for the simulation

​
simulationType
enum<string>
required
Available options:
PROMPT_SIMULATION
​
simulationConfig
Maxim Simulator · object
required

Configuration for prompt simulation

​
datasetSplitId
string

Optional dataset split ID

​
evaluators
object[]

Array of evaluators with optional variable mapping to run on the simulation results.

​
contextToEvaluate
object[]

Context sources to include in evaluation

Response

Simulation test run triggered successfully

​
data
object
required

Response from triggering a simulation