Get evaluators

Authorization

x-maxim-api-key<token>

API key for authentication

In: header

Request Body

application/jsonOptional

workspaceIdRequiredstring

Unique identifier for the workspace

Minimum length: 1

idstring

Unique identifier for the evaluator

limitnumber

Maximum number of records to return. 10 by default

Default: 10

namestring

Name of the evaluator

cursorstring

Cursor for pagination

curl -X GET "https://api.getmaxim.ai/v1/evaluators" \
  -H "x-maxim-api-key: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "workspaceId": "string",
    "id": "string",
    "limit": 10,
    "name": "string",
    "cursor": "string"
  }'

Evaluators retrieved successfully

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

Get evaluators

Authorization

Request Body

Response

TypeScript