Skip to main content
GET
Get evaluator

Authorizations

X-API-Key
string
header
required

API key for authentication

Path Parameters

evaluator_uuid
string
required

Evaluator to retrieve

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

Query Parameters

compact
boolean
default:false

Return a compact response that omits heavy detail fields (versions.system_prompt, versions.output_config, versions.variables), keeping only the lightweight decision fields. Omit for full detail

Response

Successful Response

uuid
string
required

Evaluator ID

Required string length: 36
Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

name
string
required

Evaluator name

evaluator_type
enum<string>
required

What the evaluator judges:

  • tts: TTS audio
  • stt: one transcript
  • llm: a reply with its conversation history
  • llm-general: a standalone input and output pair
  • conversation: a full conversation
Available options:
tts,
stt,
llm,
llm-general,
conversation
data_type
enum<string>
required

The modality the judge reads:

  • text
  • audio
Available options:
text,
audio
output_type
enum<string>
required

How the evaluator scores:

  • binary: pass or fail
  • rating: a numeric score, using the scale in output_config
Available options:
binary,
rating
is_default
boolean
required

True when the evaluator is a built-in default or your workspace's editable copy of one. False for an evaluator you created yourself

created_at
string
required

When the evaluator was created (ISO 8601 UTC)

updated_at
string
required

When the evaluator was last updated (ISO 8601 UTC)

versions
EvaluatorVersionCompact · object[]
required

Full version history, oldest first

description
string | null

What the evaluator checks

slug
string | null

Stable slug for a built-in default evaluator

source_default_slug
string | null

Stable slug of the built-in default this evaluator is your editable copy of. Set on your default forks so you can identify a specific default by it

live_version_id
string | null

ID of the version that is currently live

Required string length: 36
Example:

"6ba7b810-9dad-11d1-80b4-00c04fd430c8"