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>"
  ],
  "folderId": "<string>",
  "config": {
    "optionalVariables": [
      "<string>"
    ],
    "model": "<string>",
    "modelId": "<string>",
    "provider": "<string>",
    "instructions": "<string>",
    "modelParameters": "<unknown>"
  }
}
'
import requests

url = "https://api.getmaxim.ai/v1/evaluators"

payload = {
    "workspaceId": "<string>",
    "name": "<string>",
    "type": "AI",
    "description": "<string>",
    "tags": ["<string>"],
    "folderId": "<string>",
    "config": {
        "optionalVariables": ["<string>"],
        "model": "<string>",
        "modelId": "<string>",
        "provider": "<string>",
        "instructions": "<string>",
        "modelParameters": "<unknown>"
    }
}
headers = {
    "x-maxim-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'x-maxim-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    workspaceId: '<string>',
    name: '<string>',
    type: 'AI',
    description: '<string>',
    tags: ['<string>'],
    folderId: '<string>',
    config: {
      optionalVariables: ['<string>'],
      model: '<string>',
      modelId: '<string>',
      provider: '<string>',
      instructions: '<string>',
      modelParameters: '<unknown>'
    }
  })
};

fetch('https://api.getmaxim.ai/v1/evaluators', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getmaxim.ai/v1/evaluators",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'workspaceId' => '<string>',
    'name' => '<string>',
    'type' => 'AI',
    'description' => '<string>',
    'tags' => [
        '<string>'
    ],
    'folderId' => '<string>',
    'config' => [
        'optionalVariables' => [
                '<string>'
        ],
        'model' => '<string>',
        'modelId' => '<string>',
        'provider' => '<string>',
        'instructions' => '<string>',
        'modelParameters' => '<unknown>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-maxim-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getmaxim.ai/v1/evaluators"

	payload := strings.NewReader("{\n  \"workspaceId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"type\": \"AI\",\n  \"description\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"folderId\": \"<string>\",\n  \"config\": {\n    \"optionalVariables\": [\n      \"<string>\"\n    ],\n    \"model\": \"<string>\",\n    \"modelId\": \"<string>\",\n    \"provider\": \"<string>\",\n    \"instructions\": \"<string>\",\n    \"modelParameters\": \"<unknown>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-maxim-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.getmaxim.ai/v1/evaluators")
  .header("x-maxim-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workspaceId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"type\": \"AI\",\n  \"description\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"folderId\": \"<string>\",\n  \"config\": {\n    \"optionalVariables\": [\n      \"<string>\"\n    ],\n    \"model\": \"<string>\",\n    \"modelId\": \"<string>\",\n    \"provider\": \"<string>\",\n    \"instructions\": \"<string>\",\n    \"modelParameters\": \"<unknown>\"\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.getmaxim.ai/v1/evaluators")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-maxim-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workspaceId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"type\": \"AI\",\n  \"description\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"folderId\": \"<string>\",\n  \"config\": {\n    \"optionalVariables\": [\n      \"<string>\"\n    ],\n    \"model\": \"<string>\",\n    \"modelId\": \"<string>\",\n    \"provider\": \"<string>\",\n    \"instructions\": \"<string>\",\n    \"modelParameters\": \"<unknown>\"\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "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

folderId
string

Unique identifier for the folder to place the evaluator in

config
object

Response

Evaluator created successfully

data
object
required