API ReferenceEvaluators

Replace Evaluator

PUT handler with superadmin lock and field protection.

Same as patch() - checks lock and field protection before delegating.

Authentication

AuthorizationBearer

Use your Respan API key for Respan API authentication. Enter only the Respan API key value; clients send Authorization: Bearer <RESPAN_API_KEY>. For /api/responses, OpenAI or Azure OpenAI provider credentials go in Settings -> Providers or the request body credential_override field, not in this auth field.

OR
AuthorizationBearer

Use a dashboard JWT only for dashboard-authenticated endpoints. Respan API-key endpoints use the respanApiKey auth field instead.

Path parameters

evaluator_idstringRequired

Request

This endpoint expects an object.
namestringRequired1-255 characters
version_idstringOptional1-255 characters
configurationsmap from strings to anyOptional
categorical_choiceslist of maps from strings to anyOptional
score_configmap from strings to anyOptional
passing_conditionsmap from strings to any or nullOptional
llm_configmap from strings to any or nullOptional
code_configmap from strings to any or nullOptional
projectstring or nullOptional>=1 character
idstringOptional1-255 characters
versionintegerOptional-2147483648-2147483647
is_read_onlybooleanOptional
version_descriptionstringOptional
evaluator_slugstringOptional<=255 characters
unique_organization_idstring or nullOptional<=255 characters
descriptionstringOptional
typeenumOptional
  • llm - Llm
  • code - Code
  • human - Human
  • function - Function
  • human_numerical - Human Numerical
  • human_categorical - Human Categorical
  • human_boolean - Human Boolean
  • human_text - Human Text
  • custom - Custom
score_value_typeenumOptional
  • numerical - Numerical
  • boolean - Boolean
  • percentage - Percentage
  • single_select - Single Select
  • multi_select - Multi Select
  • text - Text
  • json - Json
  • comment - Comment
  • categorical - Categorical
custom_required_fieldslist of stringsOptional
starredbooleanOptional
organizationinteger or nullOptional

Response

is_publicbooleanRead-only
eval_classstringRead-only
namestring<=255 characters
created_atdatetimeRead-only
updated_atdatetimeRead-only
created_byinteger or nullRead-only
updated_byinteger or nullRead-only
version_idstring<=255 characters
configurationsmap from strings to any
categorical_choiceslist of maps from strings to any
score_configmap from strings to any
passing_conditionsmap from strings to any or null
llm_configmap from strings to any or null
code_configmap from strings to any or null
projectstring or null
idstring<=255 characters
versioninteger-2147483648-2147483647
is_read_onlyboolean
version_descriptionstring
evaluator_slugstring<=255 characters
descriptionstring
typeenum
  • llm - Llm
  • code - Code
  • human - Human
  • function - Function
  • human_numerical - Human Numerical
  • human_categorical - Human Categorical
  • human_boolean - Human Boolean
  • human_text - Human Text
  • custom - Custom
score_value_typeenum
  • numerical - Numerical
  • boolean - Boolean
  • percentage - Percentage
  • single_select - Single Select
  • multi_select - Multi Select
  • text - Text
  • json - Json
  • comment - Comment
  • categorical - Categorical
custom_required_fieldslist of strings
starredboolean