Sign in
evaluators

Update evaluator version

Partially update a specific evaluator version. Only the current draft (is_read_only: false) can be edited.

patch/api/evaluators/{evaluator_id}/versions/{version}/

Path parameters

evaluator_idstring required

Evaluator ID. To run a specific version, pass an ID with a version suffix where supported, for example evl_abc123:2.

versioninteger required

Evaluator version number.

Headers

Authorizationstring required

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, provider credentials such as Perplexity, OpenAI, or Azure OpenAI go in Settings -> Providers or respan_params.credential_override in the request body, not in this authentication field.

Request body

namestring
evaluator_slugstring

Organization-scoped evaluator slug.

type'llm' | 'human' | 'code'
score_value_type'numerical' | 'boolean' | 'percentage' | 'single_select' | 'multi_select' | 'text' | 'json' | 'comment' | 'categorical'
eval_class'keywordsai_custom_llm' | 'custom_code'

Optional pre-built evaluator template.

descriptionstring nullable
passing_conditionsApiEvaluatorsEvaluatorIdVersionsVersionPatchRequestBodyContentApplicationJsonSchemaPassingConditions

Passing conditions in the standard Respan filter format.

configurationsobject

Legacy user-facing configuration object. New clients should prefer llm_config, code_config, score_config, and passing_conditions.

starredboolean

Response

Updated evaluator version.

idstring required

Stable evaluator ID shared by all versions.

version_idstring required

Unique ID for this evaluator version.

versioninteger required

Version number. The first draft is version 0.

is_read_onlyboolean required

Whether this version is committed and immutable.

version_descriptionstring

Commit message for this version.

namestring required
descriptionstring nullable
type'llm' | 'human' | 'code' required
score_value_type'numerical' | 'boolean' | 'percentage' | 'single_select' | 'multi_select' | 'text' | 'json' | 'comment' | 'categorical' required
passing_conditionsApiEvaluatorsEvaluatorIdVersionsVersionPatchResponsesContentApplicationJsonSchemaPassingConditions

Passing conditions in the standard Respan filter format.

configurationsobject

Legacy user-facing configuration object. New clients should prefer llm_config, code_config, score_config, and passing_conditions.

eval_class'keywordsai_custom_llm' | 'custom_code'

Optional pre-built evaluator template.

starredboolean
created_atstring date-time
updated_atstring date-time
is_publicboolean

Whether this is a Respan-managed public evaluator.

Changes