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>",
"type": "AI",
"description": "<string>",
"tags": [
"<string>"
],
"config": {
"optionalVariables": [
"<string>"
],
"gradingStyle": "YesNo",
"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>",
"type": "AI",
"description": "<string>",
"tags": [
"<string>"
],
"config": {
"optionalVariables": [
"<string>"
],
"gradingStyle": "YesNo",
"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>"
}
]
}
}API key for authentication
Unique identifier for the workspace
1Name of the evaluator
1AI Description of the evaluator
Tags for the evaluator
Show child attributes
Evaluator created successfully
Show child attributes
Was this page helpful?