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": [
{
"type": "DATASOURCE",
"payload": "<string>"
}
]
}
'{
"data": {
"id": "<string>",
"workspaceId": "<string>",
"status": "<string>",
"entityType": "<string>",
"createdAt": "<string>",
"entityId": "<string>"
}
}Trigger a 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": [
{
"type": "DATASOURCE",
"payload": "<string>"
}
]
}
'{
"data": {
"id": "<string>",
"workspaceId": "<string>",
"status": "<string>",
"entityType": "<string>",
"createdAt": "<string>",
"entityId": "<string>"
}
}API key for authentication
Payload for triggering a simulation test run
Workspace ID where the simulation will run
ID of the entity to simulate (prompt version ID, workflow ID)
Dataset ID to use for the simulation
PROMPT_SIMULATION Configuration for prompt simulation
Show child attributes
Optional dataset split ID
Array of evaluators with optional variable mapping to run on the simulation results.
Show child attributes
Context sources to include in evaluation
Show child attributes
Simulation test run triggered successfully
Response from triggering a simulation
Show child attributes
Was this page helpful?