Skip to main content
POST
Create evaluator

Authorizations

X-API-Key
string
header
required

API key for authentication

Body

application/json
name
string
required

Evaluator name, unique within your workspace

Minimum string length: 1
version
EvaluatorVersionCreate · object
required

The evaluator's first version. Set as live when you create the evaluator

description
string | null

Description. Omit to leave blank

evaluator_type
enum<string>
default:llm

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>
default:text

The modality the judge reads:

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

How the evaluator scores:

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

Response

Successful Response

uuid
string
required

ID of the created evaluator

Required string length: 36
Example:

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

version_uuid
string
required

ID of its initial version

Required string length: 36
Example:

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