Sign in
scores

Update a score

Partially update a score by score ID.

patch/api/scores/{id}/

Path parameters

idstring required

Score ID returned as id in score responses.

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

Request body

numerical_valuenumber double nullable

Numeric score value. Use for numerical and percentage evaluators.

string_valuestring nullable

Text score value. Use for text and legacy comment evaluators.

boolean_valueboolean nullable

Boolean score value. Use for boolean evaluators.

categorical_valuestring[] nullable

Categorical score values. Use for single_select, multi_select, and legacy categorical evaluators.

json_valuestring nullable

JSON score value encoded as a string. Use for json evaluators.

Response

Updated score.

idstring required

Score ID.

created_atstring date-time required

When the score was created.

type'llm' | 'human' | 'code' | 'function' | 'human_numerical' | 'human_boolean' | 'human_categorical' | 'human_text' | 'custom'

Evaluator execution type. Legacy rows may contain legacy type values.

environmentstring

Environment associated with the score.

numerical_valuenumber double nullable

Numeric score value. Use for numerical and percentage evaluators.

string_valuestring nullable

Text score value. Use for text and legacy comment evaluators.

boolean_valueboolean nullable

Boolean score value. Use for boolean evaluators.

categorical_valuestring[] nullable

Categorical score values. Use for single_select, multi_select, and legacy categorical evaluators.

json_valuestring nullable

JSON score value encoded as a string. Use for json evaluators.

is_passedboolean nullable

Whether the score passes the evaluator conditions.

costnumber double nullable

Evaluation cost in USD, when available.

evaluator_idstring nullable

Evaluator ID associated with the score.

evaluator_slugstring nullable

Evaluator slug associated with the score.

evaluator_namestring nullable

Human-readable evaluator name, when available.

scorerstring nullable

Who or what produced the score. For log-scoped score writes, the backend derives this from the authenticated user.

log_idstring nullable

Associated log/span ID.

prompt_idstring nullable

Associated prompt ID, when available.

prompt_version_numberinteger nullable

Associated prompt version number, when available.

dataset_idstring nullable

Associated dataset ID, when available.

automation_idstring nullable

Associated automation ID, when available.

statusstring nullable

Evaluation status, when available.

error_messagestring nullable

Evaluation error message, when available.

evaluatorApiScoresIdPatchResponsesContentApplicationJsonSchemaEvaluator

Evaluator metadata when the score is associated with a platform evaluator.

Changes