Skip to main content
PUT
/
v1
/
evaluators
Update evaluator
curl --request PUT \
  --url https://api.getmaxim.ai/v1/evaluators \
  --header 'Content-Type: application/json' \
  --header 'x-maxim-api-key: <api-key>' \
  --data '
{
  "workspaceId": "<string>",
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "config": {
    "optionalVariables": [
      "<string>"
    ],
    "model": "<string>",
    "modelId": "<string>",
    "provider": "<string>",
    "instructions": "<string>",
    "modelParameters": "<unknown>"
  },
  "folderId": "<string>"
}
'
import requests

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

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

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

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

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 => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'workspaceId' => '<string>',
'id' => '<string>',
'name' => '<string>',
'description' => '<string>',
'tags' => [
'<string>'
],
'config' => [
'optionalVariables' => [
'<string>'
],
'model' => '<string>',
'modelId' => '<string>',
'provider' => '<string>',
'instructions' => '<string>',
'modelParameters' => '<unknown>'
],
'folderId' => '<string>'
]),
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 \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"config\": {\n \"optionalVariables\": [\n \"<string>\"\n ],\n \"model\": \"<string>\",\n \"modelId\": \"<string>\",\n \"provider\": \"<string>\",\n \"instructions\": \"<string>\",\n \"modelParameters\": \"<unknown>\"\n },\n \"folderId\": \"<string>\"\n}")

req, _ := http.NewRequest("PUT", 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.put("https://api.getmaxim.ai/v1/evaluators")
.header("x-maxim-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"workspaceId\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"config\": {\n \"optionalVariables\": [\n \"<string>\"\n ],\n \"model\": \"<string>\",\n \"modelId\": \"<string>\",\n \"provider\": \"<string>\",\n \"instructions\": \"<string>\",\n \"modelParameters\": \"<unknown>\"\n },\n \"folderId\": \"<string>\"\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::Put.new(url)
request["x-maxim-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workspaceId\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"config\": {\n \"optionalVariables\": [\n \"<string>\"\n ],\n \"model\": \"<string>\",\n \"modelId\": \"<string>\",\n \"provider\": \"<string>\",\n \"instructions\": \"<string>\",\n \"modelParameters\": \"<unknown>\"\n },\n \"folderId\": \"<string>\"\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
id
string
required

Unique identifier for the evaluator

Minimum string length: 1
name
string

Name of the evaluator

description
string

Description of the evaluator

tags
string[]

Tags for the evaluator

config
AI Evaluator · object

Configuration for the evaluator

folderId
string

Unique identifier for the folder to move the evaluator into

Response

Evaluator updated successfully

data
object
required