For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
DiscordPlatform
DocumentationIntegrationsAPI referenceSDKsChangelog
DocumentationIntegrationsAPI referenceSDKsChangelog
  • API Reference
      • POSTCreate a score
      • GETList scores
      • GETRetrieve a score
      • PATCHUpdate a score
      • DELDelete a score
      • POSTCreate or update a log score
      • GETList log scores
      • GETRetrieve a log score
      • PATCHUpdate a log score
      • DELDelete a log score
      • POSTFilter scores
      • PUTReplace a score
      • PUTReplace a log score
  • Reference
    • Filters API Reference
LogoLogo
DiscordPlatform
API ReferenceScores

Update a score

PATCH
https://api.respan.ai/api/scores/:id/
PATCH
/api/scores/:id/
$curl -X PATCH https://api.respan.ai/api/scores/id/ \
>     -H "Authorization: Bearer sk_live_xxxxx" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "numerical_value": 4.8,
>  "string_value": "Updated assessment"
>}'
1{
2  "id": "score_550e8400",
3  "created_at": "2024-01-15T09:30:00Z",
4  "type": "llm",
5  "environment": "production",
6  "numerical_value": 4.5,
7  "string_value": "Good response quality",
8  "boolean_value": true,
9  "categorical_value": [
10    "excellent"
11  ],
12  "json_value": "{\"rating\": 5, \"reason\": \"Accurate\"}",
13  "is_passed": true,
14  "cost": 0,
15  "evaluator_id": "evl_550e8400",
16  "evaluator_slug": "response_quality",
17  "evaluator_name": "Response Quality",
18  "scorer": "marcus@example.com",
19  "log_id": "log_abc123",
20  "prompt_id": "prompt_12345",
21  "prompt_version_number": 2,
22  "dataset_id": "dataset_67890",
23  "automation_id": "automation_13579",
24  "status": "completed",
25  "error_message": "",
26  "inputs": {
27    "input": null,
28    "output": null,
29    "metrics": {},
30    "metadata": {}
31  },
32  "evaluator": {}
33}
Partially update a score by score ID.
Was this page helpful?
Previous

Delete a score

Next
Built with

Path parameters

idstringRequired

Score ID returned as id in score responses.

Headers

AuthorizationstringRequired

Bearer token. Use Bearer YOUR_API_KEY for API key auth or Bearer <JWT> for dashboard auth.

Request

Update one or more score values. Use the value field matching the evaluator `score_value_type`: `numerical`/`percentage` -> `numerical_value`, `boolean` -> `boolean_value`, `single_select`/`multi_select`/`categorical` -> `categorical_value`, `text`/`comment` -> `string_value`, `json` -> `json_value`.
numerical_valuedouble or nullOptional

Numeric score value. Use for numerical and percentage evaluators.

string_valuestring or nullOptional

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

boolean_valueboolean or nullOptional

Boolean score value. Use for boolean evaluators.

categorical_valuelist of strings or nullOptional

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

json_valuestring or nullOptional

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

Response

Updated score.
idstring
Score ID.
created_atdatetime
When the score was created.
typeenum
Evaluator execution type. Legacy rows may contain legacy type values.
environmentstring
Environment associated with the score.
numerical_valuedouble or null

Numeric score value. Use for numerical and percentage evaluators.

string_valuestring or null

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

boolean_valueboolean or null

Boolean score value. Use for boolean evaluators.

categorical_valuelist of strings or null

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

json_valuestring or null

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

is_passedboolean or null
Whether the score passes the evaluator conditions.
costdouble or null
Evaluation cost in USD, when available.
evaluator_idstring or null
Evaluator ID associated with the score.
evaluator_slugstring or null
Evaluator slug associated with the score.
evaluator_namestring or null

Human-readable evaluator name, when available.

scorerstring or null

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

log_idstring or null

Associated log/span ID.

prompt_idstring or null
Associated prompt ID, when available.
prompt_version_numberinteger or null
Associated prompt version number, when available.
dataset_idstring or null
Associated dataset ID, when available.
automation_idstring or null
Associated automation ID, when available.
statusstring or null
Evaluation status, when available.
error_messagestring or null
Evaluation error message, when available.
inputsobject
Unified evaluator inputs stored with the score, when available.
evaluatorobject or null
Evaluator metadata when the score is associated with a platform evaluator.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error

Update one or more score values. Use the value field matching the evaluator score_value_type: numerical/percentage -> numerical_value, boolean -> boolean_value, single_select/multi_select/categorical -> categorical_value, text/comment -> string_value, json -> json_value.