List Evaluations

GET /api/public/v2/evaluations

List Evaluations

cURL

curl --request GET \
  --url https://api.promptlayer.com/api/public/v2/evaluations \
  --header 'X-API-KEY: <x-api-key>'

200

{
  "success": true,
  "message": "<string>",
  "evaluations": [
    {
      "id": 123,
      "name": "<string>",
      "workspace_id": 123,
      "comment": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "folder_id": 123,
      "user_id": 123,
      "dataset_id": 123,
      "is_blueprint": true,
      "tags": {},
      "deleted": true,
      "parent_report_id": 123,
      "score_configuration": {},
      "runs": [
        {
          "id": 123,
          "name": "<string>",
          "comment": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "workspace_id": 123,
          "folder_id": 123,
          "user_id": 123,
          "dataset_id": 123,
          "is_blueprint": true,
          "tags": {},
          "deleted": true,
          "parent_report_id": 123,
          "score_configuration": {},
          "score": {},
          "score_matrix": "<array>",
          "score_calculation_error": "<string>",
          "status": "RUNNING",
          "stats": {
            "status_counts": {}
          }
        }
      ]
    }
  ],
  "page": 123,
  "per_page": 123,
  "total": 123,
  "pages": 123
}

Retrieve a paginated list of evaluations in your workspace.

Authentication

This endpoint requires API key authentication.

Filtering by Name

Use the name parameter to search for evaluations by name. The search is case-insensitive and matches partial names. This is useful for discovering existing evaluations programmatically.

Filtering by Status

Use the status parameter to control which evaluations are returned based on their deletion status:

• active (default): Returns only active evaluations
• deleted: Returns only deleted/archived evaluations
• all: Returns both active and deleted evaluations

Including Batch Runs

Use the include_runs parameter to include batch run details nested under each evaluation. When set to true, each evaluation object in the response will include a runs array containing all of its batch runs with their status and cell status counts.

This is useful for programmatically discovering batch run IDs without needing to inspect the UI.

Headers

X-API-KEY · string · required

Your PromptLayer API key.

Query Parameters

workspace_id · integer

Filter by specific workspace ID. If not provided, uses the current user's workspace

Required range: x >= 1

name · string

Filter evaluations by name (case-insensitive partial match)

status · enum<string> · default: active

Filter evaluations by status: 'active' (default) returns only active evaluations, 'deleted' returns only deleted/archived evaluations, 'all' returns both

Available options: active, deleted, all

include_runs · boolean · default: false

If true, include batch runs nested under each evaluation. Each run includes its full report data, status (RUNNING or COMPLETED), and cell status counts.

page · integer · default: 1

Page number for pagination

Required range: x >= 1

per_page · integer · default: 10

Number of items per page

Required range: 1 <= x <= 100

Response

200

application/json

Successful response

success · boolean · required

message · string · required

evaluations · object[] · required

Show child attributes

page · integer · required

per_page · integer · required

total · integer · required

pages · integer · required