curl --request POST \
--url https://api.getmaxim.ai/v1/test-runs/single-turn/workflow \
--header 'Content-Type: application/json' \
--header 'x-maxim-api-key: <api-key>' \
--data '
{
"workspaceId": "<string>",
"datasetId": "<string>",
"workflowId": "<string>",
"datasetSplitId": "<string>",
"evaluators": [
{
"id": "<string>",
"name": "<string>",
"variableMapping": {}
}
],
"contextToEvaluate": [
{
"type": "DATASOURCE",
"payload": "<string>"
}
],
"environmentId": "<string>"
}
'{
"data": {
"id": "<string>",
"workspaceId": "<string>",
"status": "<string>",
"entityType": "<string>",
"createdAt": "<string>",
"entityId": "<string>"
}
}Trigger a single-turn workflow test run.
curl --request POST \
--url https://api.getmaxim.ai/v1/test-runs/single-turn/workflow \
--header 'Content-Type: application/json' \
--header 'x-maxim-api-key: <api-key>' \
--data '
{
"workspaceId": "<string>",
"datasetId": "<string>",
"workflowId": "<string>",
"datasetSplitId": "<string>",
"evaluators": [
{
"id": "<string>",
"name": "<string>",
"variableMapping": {}
}
],
"contextToEvaluate": [
{
"type": "DATASOURCE",
"payload": "<string>"
}
],
"environmentId": "<string>"
}
'{
"data": {
"id": "<string>",
"workspaceId": "<string>",
"status": "<string>",
"entityType": "<string>",
"createdAt": "<string>",
"entityId": "<string>"
}
}API key for authentication
Payload for triggering a single-turn workflow test run
Workspace ID where the test run will execute
Dataset ID to use for the test run
Workflow ID to 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
Environment ID for variable resolution in the workflow config
Single-turn workflow test run triggered successfully
Response from triggering a simulation
Show child attributes
Was this page helpful?