Skip to main content
POST
/
v1
/
evaluators
Create 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": {
    "passFailCriteria": {
      "entryLevel": {
        "value": 123,
        "operator": "<string>",
        "name": "<string>"
      },
      "runLevel": {
        "value": 123,
        "operator": "<string>",
        "name": "<string>"
      }
    },
    "optionalVariables": [
      "<string>"
    ],
    "gradingStyle": "YesNo",
    "scale": {
      "min": 123,
      "max": 123
    },
    "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>"
      }
    ]
  }
}

Authorizations

x-maxim-api-key
string
header
required

API key for authentication

Body

application/json
workspaceId
string
required

Unique identifier for the workspace

Minimum string length: 1
name
string
required

Name of the evaluator

Minimum string length: 1
type
enum<string>
required
Available options:
AI
description
string

Description of the evaluator

tags
string[]

Tags for the evaluator

config
object

Response

Evaluator created successfully

data
object
required