curl --request POST \
--url https://api.getmaxim.ai/v1/test-runs/single-turn/prompt \
--header 'Content-Type: application/json' \
--header 'x-maxim-api-key: <api-key>' \
--data '
{
"workspaceId": "<string>",
"datasetId": "<string>",
"datasetSplitId": "<string>",
"evaluators": [
{
"id": "<string>",
"name": "<string>",
"variableMapping": {}
}
],
"contextToEvaluate": [
{
"type": "DATASOURCE",
"payload": "<string>"
}
],
"promptVersionId": "<string>",
"promptVersionIds": [
"<string>"
]
}
'{
"data": {
"id": "<string>",
"workspaceId": "<string>",
"status": "<string>",
"entityType": "<string>",
"createdAt": "<string>",
"entityId": "<string>"
}
}Trigger a single-turn prompt test run (single or comparison).
curl --request POST \
--url https://api.getmaxim.ai/v1/test-runs/single-turn/prompt \
--header 'Content-Type: application/json' \
--header 'x-maxim-api-key: <api-key>' \
--data '
{
"workspaceId": "<string>",
"datasetId": "<string>",
"datasetSplitId": "<string>",
"evaluators": [
{
"id": "<string>",
"name": "<string>",
"variableMapping": {}
}
],
"contextToEvaluate": [
{
"type": "DATASOURCE",
"payload": "<string>"
}
],
"promptVersionId": "<string>",
"promptVersionIds": [
"<string>"
]
}
'{
"data": {
"id": "<string>",
"workspaceId": "<string>",
"status": "<string>",
"entityType": "<string>",
"createdAt": "<string>",
"entityId": "<string>"
}
}API key for authentication
Payload for triggering a single-turn prompt test run or comparison run
Workspace ID where the test run will execute
Dataset ID to use for the test run
Optional dataset split ID
Array of evaluators with optional variable mapping to run on the test results.
Show child attributes
Context sources to include in evaluation
Show child attributes
Prompt version ID to run for single run
Prompt version IDs to run for comparison
2Single-turn prompt test run triggered successfully
Response from triggering a simulation
Show child attributes
Was this page helpful?