Skip to main content
PATCH
/
v2
/
evaluators
/
{id}
Update an Evaluator
curl --request PATCH \
  --url https://api.orq.ai/v2/evaluators/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "<string>",
  "path": "Default",
  "key": "<string>",
  "description": "<string>",
  "prompt": "<string>",
  "output_type": "<string>",
  "categories": [
    "<string>"
  ],
  "categorical_labels": [
    {
      "value": "<string>",
      "description": "<string>"
    }
  ],
  "repetitions": 123,
  "model": "<string>",
  "schema": "<string>",
  "url": "<string>",
  "method": "<string>",
  "headers": {},
  "payload": {},
  "code": "<string>",
  "guardrail_config": {
    "enabled": true,
    "value": true,
    "alert_on_failure": false
  },
  "versionDescription": "<string>"
}
'
{
  "_id": "<string>",
  "description": "<string>",
  "prompt": "<string>",
  "key": "<string>",
  "model": "<string>",
  "created": "2026-05-21T15:14:33.278Z",
  "updated": "2026-05-21T15:14:33.278Z",
  "guardrail_config": {
    "enabled": true,
    "value": true,
    "alert_on_failure": false
  },
  "repetitions": 2,
  "categories": [
    "<string>"
  ],
  "categorical_labels": [
    {
      "value": "<string>",
      "description": "<string>"
    }
  ],
  "dataset_id": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.orq.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Body

application/json
​
type
string

Evaluator type. Optional on update — inferred from existing evaluator.

​
path
string

Project path. Optional on update — uses existing project if omitted.

Example:

"Default"

​
key
string
Minimum string length: 1
Pattern: ^[a-zA-Z0-9]([a-zA-Z0-9_-]*[a-zA-Z0-9])?$
​
description
string
​
prompt
string
​
output_type
string
​
categories
string[] | null
​
categorical_labels
object[] | null
​
repetitions
number
​
mode
enum<string>
Available options:
single,
jury
​
model
string
​
jury
object
​
schema
string
​
url
string
​
method
string
​
headers
object
​
payload
object
​
code
string
​
guardrail_config
Boolean · object
​
versionIncrement
enum<string>
Available options:
major,
minor,
patch
​
versionDescription
string

Response

Successfully updated an eval

​
_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
​
model
string
required
​
created
string
default:2026-05-21T15:14:33.278Z
​
updated
string
default:2026-05-21T15:14:33.278Z
​
guardrail_config
Boolean · object
​
repetitions
integer
Required range: 1 <= x <= 3
​
categories
string[]
​
categorical_labels
object[]
​
dataset_id
string