curl --request POST \
--url https://api.getmaxim.ai/v1/evaluators \
--header 'Content-Type: application/json' \
--header 'x-maxim-api-key: <api-key>' \
--data '
{
"workspaceId": "<string>",
"name": "<string>",
"description": "<string>",
"tags": [
"<string>"
],
"folderId": "<string>",
"config": {
"optionalVariables": [
"<string>"
],
"model": "<string>",
"modelId": "<string>",
"provider": "<string>",
"instructions": "<string>",
"modelParameters": "<unknown>"
}
}
'{
"data": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"type": "<string>",
"config": {
"model": "<string>",
"provider": "<string>",
"gradingStyle": "<string>",
"passFailCriteria": {
"runLevel": {
"name": "<string>",
"value": 123,
"operator": "<string>"
},
"entryLevel": {
"name": "<string>",
"value": "<string>",
"operator": "<string>"
}
},
"variables": {}
},
"accountId": "<string>",
"workspaceId": "<string>",
"builtin": true,
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>",
"tags": [
{
"label": "<string>",
"value": "<string>"
}
]
}
}Create a new evaluator
curl --request POST \
--url https://api.getmaxim.ai/v1/evaluators \
--header 'Content-Type: application/json' \
--header 'x-maxim-api-key: <api-key>' \
--data '
{
"workspaceId": "<string>",
"name": "<string>",
"description": "<string>",
"tags": [
"<string>"
],
"folderId": "<string>",
"config": {
"optionalVariables": [
"<string>"
],
"model": "<string>",
"modelId": "<string>",
"provider": "<string>",
"instructions": "<string>",
"modelParameters": "<unknown>"
}
}
'{
"data": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"type": "<string>",
"config": {
"model": "<string>",
"provider": "<string>",
"gradingStyle": "<string>",
"passFailCriteria": {
"runLevel": {
"name": "<string>",
"value": 123,
"operator": "<string>"
},
"entryLevel": {
"name": "<string>",
"value": "<string>",
"operator": "<string>"
}
},
"variables": {}
},
"accountId": "<string>",
"workspaceId": "<string>",
"builtin": true,
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>",
"tags": [
{
"label": "<string>",
"value": "<string>"
}
]
}
}Documentation Index
Fetch the complete documentation index at: https://www.getmaxim.ai/docs/llms.txt
Use this file to discover all available pages before exploring further.
API key for authentication
Unique identifier for the workspace
1Name of the evaluator
1AI Description of the evaluator
Tags for the evaluator
Unique identifier for the folder to place the evaluator in
Show child attributes
Evaluator created successfully
Show child attributes
Was this page helpful?