GET
/
evaluate
curl --request GET \
  --url https://api.deeprails.com/evaluate \
  --header 'Authorization: Bearer <token>'
{
  "evaluations": [
    {
      "eval_id": "eval-123e4567-e89b-12d3-a456-426614174000",
      "evaluation_status": "completed",
      "guardrail_metrics": [
        "correctness",
        "completeness"
      ],
      "model_used": "gpt-4",
      "model_input": {},
      "model_output": "<string>",
      "progress": 75,
      "created_at": "2024-01-01T00:00:00Z",
      "start_timestamp": "2024-01-01T00:01:00Z",
      "completion_timestamp": "2024-01-01T00:05:00Z",
      "error_message": "Failed to connect to evaluation service",
      "error_timestamp": "2024-01-01T00:03:00Z",
      "evaluation_result": {
        "correctness": 0.95,
        "completeness": 0.88,
        "overall_score": 0.92
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total_pages": 5,
    "total_count": 100,
    "has_next": true,
    "has_previous": false
  },
  "filters_applied": {
    "search": "customer support",
    "status": "completed",
    "monitor_id": "mon-123",
    "date_from": "2024-01-01T00:00:00Z",
    "date_to": "2024-01-31T23:59:59Z",
    "sort_by": "created_at",
    "sort_order": "desc"
  }
}

Authorizations

​
Authorization
string
header
required

JWT token for authentication

Query Parameters

​
page
integer
default:1

Page number for pagination

Required range: x >= 1
​
limit
integer
default:20

Number of items per page (max 100)

Required range: 1 <= x <= 100
​
search
string

Search term to filter evaluations

​
status
enum<string>

Filter by evaluation status. Use 'completed' to include both completed and partially_completed evaluations

Available options:
queued,
completed,
failed,
in_progress,
partially_completed,
cancelled
​
monitor_id
string

Filter by monitor ID

​
date_from
string

Filter evaluations from this date (ISO format)

​
date_to
string

Filter evaluations to this date (ISO format)

​
sort_by
enum<string>
default:created_at

Field to sort by

Available options:
created_at,
modified_at,
evaluation_status,
eval_id,
start_timestamp,
completion_timestamp
​
sort_order
enum<string>
default:desc

Sort order (asc or desc)

Available options:
asc,
desc

Response

200
application/json

Evaluations retrieved successfully

The response is of type object.