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

List scores

GET
https://api.respan.ai/api/scores/
GET
/api/scores/
$curl https://api.respan.ai/api/scores/ \
>     -H "Authorization: Bearer sk_live_xxxxx" \
>     -H "Content-Type: application/json"
1{
2  "count": 2,
3  "results": [
4    {
5      "id": "score_550e8400",
6      "created_at": "2024-01-15T09:30:00Z",
7      "type": "llm",
8      "environment": "production",
9      "numerical_value": 4.5,
10      "string_value": "Good response quality",
11      "boolean_value": true,
12      "categorical_value": [
13        "excellent"
14      ],
15      "json_value": "{\"rating\": 5, \"reason\": \"Accurate\"}",
16      "is_passed": true,
17      "cost": 0.02,
18      "evaluator_id": "evl_550e8400",
19      "evaluator_slug": "response_quality",
20      "evaluator_name": "Response Quality",
21      "scorer": "marcus@example.com",
22      "log_id": "log_abc123",
23      "prompt_id": "prompt_12345",
24      "prompt_version_number": 3,
25      "dataset_id": "dataset_98765",
26      "automation_id": "auto_45678",
27      "status": "completed",
28      "error_message": null
29    },
30    {
31      "id": "score_550e8401",
32      "created_at": "2024-01-15T09:45:00Z",
33      "type": "human_boolean",
34      "environment": "staging",
35      "numerical_value": null,
36      "string_value": null,
37      "boolean_value": false,
38      "categorical_value": null,
39      "json_value": null,
40      "is_passed": false,
41      "cost": 0,
42      "evaluator_id": "evl_550e8401",
43      "evaluator_slug": "human_feedback",
44      "evaluator_name": "Human Feedback",
45      "scorer": "jane.doe@example.com",
46      "log_id": "log_def456",
47      "prompt_id": "prompt_12346",
48      "prompt_version_number": 1,
49      "dataset_id": "dataset_98766",
50      "automation_id": null,
51      "status": "completed",
52      "error_message": null
53    }
54  ],
55  "next": "https://api.respan.ai/api/scores/?page=2&page_size=2",
56  "previous": null,
57  "current_filters": {}
58}

List evaluation scores with pagination. For complex filters, use POST /api/scores/list/.

Was this page helpful?
Previous

Retrieve a score

Next
Built with

Headers

AuthorizationstringRequired

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

Query parameters

pageintegerOptional>=1
Page number.
page_sizeintegerOptional1-100
Number of results to return per page. Maximum 100.
start_timedatetimeOptional
Filter scores created at or after this timestamp.
end_timedatetimeOptional
Filter scores created before this timestamp.

Response

Paginated list of scores.
countinteger
Number of scores returned on this page.
resultslist of objects
nextstring or null
URL for the next page, if any.
previousstring or null
URL for the previous page, if any.
current_filtersobject
Normalized filters applied to this request.

Errors

401
Unauthorized Error