Get evaluators

Get an evaluator by ID, name or fetch all evaluators for a workspace

GET /v1/evaluators

Get evaluators

cURL

curl --request GET \
  --url https://api.getmaxim.ai/v1/evaluators \
  --header 'x-maxim-api-key: <api-key>'

200

{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "type": "<string>",
    "config": {
      "model": "<string>",
      "provider": "<string>",
      "gradingStyle": "<string>",
      "passFailCriteria": {
        "runLevel": {
          "name": "<string>",
          "value": 123,
          "operator": "<string>"
        },
        "entryLevel": {
          "name": "<string>",
          "value": "<string>",
          "operator": "<string>"
        }
      },
      "variables": {}
    },
    "accountId": "<string>",
    "workspaceId": "<string>",
    "builtin": true,
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>",
    "tags": [
      {
        "label": "<string>",
        "value": "<string>"
      }
    ]
  },
  "pagination": {
    "cursor": "<string>",
    "hasMore": true
  }
}

Authorizations

x-maxim-api-key · string · header · required

API key for authentication

Query Parameters

workspaceId · string · required

Unique identifier for the workspace

Minimum string length: 1

id · string

Unique identifier for the evaluator

limit · number | null · default: 10

Maximum number of records to return. 10 by default

name · string

Name of the evaluator

cursor · string

Cursor for pagination

Response

200

application/json

Evaluators retrieved successfully

data · object · required

object

object[]

Show child attributes

pagination · object

Show child attributes