Execute an evaluator

Overview

Prompts

Prompt Tools

Prompt Partials

Datasets

Evaluators

Log repositories

Folders

Workflows

Integrations

Alerts

Models

Test runs

Test run entries

Test run reports

Logging

Workspaces

Execute an evaluator

curl --request POST \
  --url https://api.getmaxim.ai/v1/evaluators/execute \
  --header 'Content-Type: application/json' \
  --header 'x-maxim-api-key: <api-key>' \
  --data '
{
  "workspaceId": "<string>",
  "id": "<string>",
  "name": "<string>",
  "variables": {}
}
'

import requests

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

payload = {
    "workspaceId": "<string>",
    "id": "<string>",
    "name": "<string>",
    "variables": {}
}
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>', id: '<string>', name: '<string>', variables: {}})
};

fetch('https://api.getmaxim.ai/v1/evaluators/execute', 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/execute",
  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>',
    'id' => '<string>',
    'name' => '<string>',
    'variables' => [
        
    ]
  ]),
  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/execute"

	payload := strings.NewReader("{\n  \"workspaceId\": \"<string>\",\n  \"id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"variables\": {}\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/execute")
  .header("x-maxim-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workspaceId\": \"<string>\",\n  \"id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"variables\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"variables\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "result": "<string>",
    "logs": [
      {
        "timestamp": "<string>",
        "type": "<string>",
        "text": "<string>"
      }
    ],
    "reasoning": "<string>"
  }
}

POST

evaluators

execute

Execute an evaluator

curl --request POST \
  --url https://api.getmaxim.ai/v1/evaluators/execute \
  --header 'Content-Type: application/json' \
  --header 'x-maxim-api-key: <api-key>' \
  --data '
{
  "workspaceId": "<string>",
  "id": "<string>",
  "name": "<string>",
  "variables": {}
}
'

import requests

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

payload = {
    "workspaceId": "<string>",
    "id": "<string>",
    "name": "<string>",
    "variables": {}
}
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>', id: '<string>', name: '<string>', variables: {}})
};

fetch('https://api.getmaxim.ai/v1/evaluators/execute', 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/execute",
  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>',
    'id' => '<string>',
    'name' => '<string>',
    'variables' => [
        
    ]
  ]),
  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/execute"

	payload := strings.NewReader("{\n  \"workspaceId\": \"<string>\",\n  \"id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"variables\": {}\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/execute")
  .header("x-maxim-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workspaceId\": \"<string>\",\n  \"id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"variables\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"variables\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "result": "<string>",
    "logs": [
      {
        "timestamp": "<string>",
        "type": "<string>",
        "text": "<string>"
      }
    ],
    "reasoning": "<string>"
  }
}

Authorizations

x-maxim-api-key

string

header

required

API key for authentication

Body

application/json

Payload for executing an evaluator

workspaceId

string

required

Unique identifier for the workspace

Minimum string length: 1

string

Unique identifier for the evaluator

Minimum string length: 1

name

string

Name of the evaluator

Minimum string length: 1

language

enum<string>

Programming language for the evaluator

Available options:

javascript,

python

variables

object

Variables to be used in evaluation

Show child attributes

{key}

string

Response

Evaluator executed successfully

data

object

required

Show child attributes

⌘I