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.
Sign inBook a demo
DocsReferenceChangelog
DocsReferenceChangelog
  • Introduction
    • Overview
    • Errors
  • SDK
    • Overview
    • Decorators
    • Run Evaluation
  • API
      • POSTSubmit Evaluator Judgment
      • GETList Evaluators
      • POSTUpsert Evaluator
      • GETGet Evaluator
      • DELDelete Evaluator
      • PATCHMove Evaluator
      • GETList Versions of an Evaluator
      • DELDelete Evaluator Version
      • PATCHUpdate Evaluator Version
      • POSTDeploy Evaluator
      • DELRemove Deployment
      • GETList an Evaluator's Environments
      • POSTUpdate Monitoring
LogoLogo
Sign inBook a demo
APIEvaluators

List Evaluators

GET
https://api.humanloop.com/v5/evaluators
GET
/v5/evaluators
$curl -G https://api.humanloop.com/v5/evaluators \
> -H "X-API-KEY: <apiKey>" \
> -d size=1
1{
2 "records": [
3 {
4 "path": "Shared Evaluators/Accuracy Evaluator",
5 "id": "ev_890bcd",
6 "spec": {
7 "arguments_type": "target_required",
8 "return_type": "number",
9 "evaluator_type": "python",
10 "code": "def evaluate(answer, target):\n return 0.5"
11 },
12 "name": "Accuracy Evaluator",
13 "version_id": "evv_012def",
14 "created_at": "2024-05-01T12:00:00Z",
15 "updated_at": "2024-05-01T12:00:00Z",
16 "last_used_at": "2024-05-01T12:00:00Z",
17 "version_logs_count": 1,
18 "total_logs_count": 1,
19 "inputs": [
20 {
21 "name": "answer"
22 }
23 ],
24 "type": "evaluator"
25 }
26 ],
27 "page": 0,
28 "size": 1,
29 "total": 1
30}
Get a list of all Evaluators.
Was this page helpful?
Previous

Upsert Evaluator

Next
Built with

Authentication

X-API-KEYstring
API Key authentication via header

Query parameters

pageintegerOptional>=1Defaults to 1
Page offset for pagination.
sizeintegerOptionalDefaults to 10
Page size for pagination. Number of Evaluators to fetch.
namestringOptional

Case-insensitive filter for Evaluator name.

user_filterstringOptional

Case-insensitive filter for users in the Evaluator. This filter matches against both email address and name of users.

sort_byenumOptional
Field to sort Evaluators by
Allowed values:
orderenumOptional
Direction to sort by.
Allowed values:

Response

Successful Response
recordslist of objects
pageinteger
sizeinteger
totalinteger

Errors

422
List Evaluators Get Request Unprocessable Entity Error