Skip to main content
Opik Documentation

Search documentation

Type to search this documentation.

Get automation rule evaluator by id

GET/v1/private/automations/evaluators/{id}Get automation rule evaluator by id

Get automation rule by id

Parameters

project_idstring · uuidquery
idstring · uuidpathrequired

Responses

200Automation Rule resourceapplication/json
objectAutomationRuleEvaluator_Public
actionstringrequired

one of "evaluator", "annotation_queue_router"

created_atstring · date-time
created_bystring
enabledboolean
idstring · uuid
last_updated_atstring · date-time
last_updated_bystring
namestringrequired

maxLength 150 · minLength 0

project_idstring · uuid

Primary project ID (legacy field for backwards compatibility)

project_namestring

Primary project name (legacy field for backwards compatibility)

projectsarray of object

Projects assigned to this rule (unique, sorted alphabetically by name)

uniqueItems true

Show child attributes

uniqueItems true

Show array items

Project reference with ID and name

project_idstring · uuidrequired

Project ID

project_namestringrequired

Project name

sampling_ratenumber · float

Fraction of production (SDK-logged) items this rule scores, from 0 to 1. Trace rules ignore this value for experiment, playground and optimization traces and score them in full; span and thread rules only ever evaluate SDK-logged data.

maximum 1 · minimum 0

trigger_scopestring

Controls whether the rule fires on production traces, experiment traces, or both. Defaults to 'production' if omitted.

one of "production", "experiment", "both"

typestringrequired

one of "llm_as_judge", "user_defined_metric_python", "trace_thread_llm_as_judge", "trace_thread_user_defined_metric_python", "span_llm_as_judge", "span_user_defined_metric_python"

Example response
{
  "action": "annotation_queue_router",
  "created_at": "2026-06-09T00:00:00Z",
  "created_by": "string",
  "enabled": true,
  "id": "00000000-0000-0000-0000-000000000000",
  "last_updated_at": "2026-06-09T00:00:00Z",
  "last_updated_by": "string",
  "name": "string",
  "project_id": "00000000-0000-0000-0000-000000000000",
  "project_name": "string",
  "projects": [
    {
      "project_id": "00000000-0000-0000-0000-000000000000",
      "project_name": "string"
    }
  ],
  "sampling_rate": 0,
  "trigger_scope": "both",
  "type": "llm_as_judge"
}
Documentation menu