Create an Evaluator

cURL

curl --request POST \
  --url https://my.orq.ai/v2/evaluators \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "llm_eval",
  "prompt": "<string>",
  "key": "<string>",
  "mode": "single",
  "model": "<string>",
  "guardrail_config": {
    "type": "boolean",
    "value": true,
    "enabled": true,
    "alert_on_failure": false
  },
  "repetitions": 2,
  "categories": [
    "<string>"
  ],
  "categorical_labels": [
    {
      "value": "<string>",
      "description": "<string>"
    }
  ],
  "dataset_id": "<string>",
  "path": "Default",
  "project_id": "01JMDPA3QW5C1V0NJ1PW34T4E5",
  "description": ""
}
'

import { Orq } from '@orq-ai/node';

const orq = new Orq({ apiKey: process.env.ORQ_API_KEY });
const evaluator = await orq.evals.create({
  type: 'python_eval',
  key: 'answer_quality',
  path: 'Default',
  code: 'def evaluate(**kwargs):\n    return True',
  outputType: 'boolean',
});

console.log(evaluator.id);

import requests

url = "https://my.orq.ai/v2/evaluators"

payload = {
    "type": "llm_eval",
    "prompt": "<string>",
    "key": "<string>",
    "mode": "single",
    "model": "<string>",
    "guardrail_config": {
        "type": "boolean",
        "value": True,
        "enabled": True,
        "alert_on_failure": False
    },
    "repetitions": 2,
    "categories": ["<string>"],
    "categorical_labels": [
        {
            "value": "<string>",
            "description": "<string>"
        }
    ],
    "dataset_id": "<string>",
    "path": "Default",
    "project_id": "01JMDPA3QW5C1V0NJ1PW34T4E5",
    "description": ""
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "_id": "<string>",
  "description": "<string>",
  "type": "llm_eval",
  "prompt": "<string>",
  "key": "<string>",
  "mode": "single",
  "created": "2026-08-05T15:12:51.947Z",
  "updated": "2026-08-05T15:12:51.947Z",
  "updated_by_id": "<string>",
  "project_id": "<string>",
  "guardrail_config": {
    "type": "boolean",
    "value": true,
    "enabled": true,
    "alert_on_failure": false
  },
  "repetitions": 2,
  "categories": [
    "<string>"
  ],
  "categorical_labels": [
    {
      "value": "<string>",
      "description": "<string>"
    }
  ],
  "dataset_id": "<string>",
  "model": "<string>",
  "jury": {
    "judges": [
      {
        "model": "<string>",
        "retry": {
          "count": 2,
          "on_codes": [
            429,
            500,
            502,
            503,
            504
          ]
        },
        "fallbacks": []
      }
    ],
    "replacement_judges": [],
    "min_successful_judges": 2,
    "tie_value": "Tie"
  }
}

{
  "message": "<string>"
}

POST

evaluators

cURL

curl --request POST \
  --url https://my.orq.ai/v2/evaluators \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "llm_eval",
  "prompt": "<string>",
  "key": "<string>",
  "mode": "single",
  "model": "<string>",
  "guardrail_config": {
    "type": "boolean",
    "value": true,
    "enabled": true,
    "alert_on_failure": false
  },
  "repetitions": 2,
  "categories": [
    "<string>"
  ],
  "categorical_labels": [
    {
      "value": "<string>",
      "description": "<string>"
    }
  ],
  "dataset_id": "<string>",
  "path": "Default",
  "project_id": "01JMDPA3QW5C1V0NJ1PW34T4E5",
  "description": ""
}
'

import { Orq } from '@orq-ai/node';

const orq = new Orq({ apiKey: process.env.ORQ_API_KEY });
const evaluator = await orq.evals.create({
  type: 'python_eval',
  key: 'answer_quality',
  path: 'Default',
  code: 'def evaluate(**kwargs):\n    return True',
  outputType: 'boolean',
});

console.log(evaluator.id);

import requests

url = "https://my.orq.ai/v2/evaluators"

payload = {
    "type": "llm_eval",
    "prompt": "<string>",
    "key": "<string>",
    "mode": "single",
    "model": "<string>",
    "guardrail_config": {
        "type": "boolean",
        "value": True,
        "enabled": True,
        "alert_on_failure": False
    },
    "repetitions": 2,
    "categories": ["<string>"],
    "categorical_labels": [
        {
            "value": "<string>",
            "description": "<string>"
        }
    ],
    "dataset_id": "<string>",
    "path": "Default",
    "project_id": "01JMDPA3QW5C1V0NJ1PW34T4E5",
    "description": ""
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "_id": "<string>",
  "description": "<string>",
  "type": "llm_eval",
  "prompt": "<string>",
  "key": "<string>",
  "mode": "single",
  "created": "2026-08-05T15:12:51.947Z",
  "updated": "2026-08-05T15:12:51.947Z",
  "updated_by_id": "<string>",
  "project_id": "<string>",
  "guardrail_config": {
    "type": "boolean",
    "value": true,
    "enabled": true,
    "alert_on_failure": false
  },
  "repetitions": 2,
  "categories": [
    "<string>"
  ],
  "categorical_labels": [
    {
      "value": "<string>",
      "description": "<string>"
    }
  ],
  "dataset_id": "<string>",
  "model": "<string>",
  "jury": {
    "judges": [
      {
        "model": "<string>",
        "retry": {
          "count": 2,
          "on_codes": [
            429,
            500,
            502,
            503,
            504
          ]
        },
        "fallbacks": []
      }
    ],
    "replacement_judges": [],
    "min_successful_judges": 2,
    "tie_value": "Tie"
  }
}

{
  "message": "<string>"
}

Related guide: Evaluators guide. See the Evaluators guide for a walkthrough with examples.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

LLM
LLM Jury
Python

type

enum<string>

required

Available options:

llm_eval

prompt

string

required

key

string

required

Minimum string length: 1

Pattern: ^[a-zA-Z0-9]([a-zA-Z0-9_-]*[a-zA-Z0-9])?$

mode

enum<string>

required

Available options:

single

model

string

required

guardrail_config

Boolean · object

Boolean
Categorical
Number

Show child attributes

output_type

enum<string>

The type of output expected from the evaluator

Available options:

boolean,

categorical,

number,

string

repetitions

integer | null

Required range: 1 <= x <= 3

Response

Successfully created an evaluator

_id

string

required

description

string

required

type

enum<string>

required

Available options:

llm_eval

prompt

string

required

key

string

required

Minimum string length: 1

Pattern: ^[a-zA-Z0-9]([a-zA-Z0-9_-]*[a-zA-Z0-9])?$

mode

enum<string>

required

Available options:

single,

jury

created

string

default:2026-08-05T15:12:51.947Z

updated

string

default:2026-08-05T15:12:51.947Z

updated_by_id

string | null

project_id

string

Unique identifier of the project owning this evaluator.

guardrail_config

Boolean · object

Boolean
Categorical
Number

Show child attributes

repetitions

integer | null

Required range: 1 <= x <= 3

Orq SDK

Terminal & Agents

Terraform

Platform APIs

Management APIs

Authorizations

Body

Response