---
title: "Preview Evaluation Suite"
method: GET
path: "/v1/projects/{project_id}/evaluation-suites/{suite_id}/preview"
tags: ["projects"]
---

# Preview Evaluation Suite

`GET /v1/projects/{project_id}/evaluation-suites/{suite_id}/preview`

## Request

- Base URL: `https://api.pioneer.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.pioneer.ai/v1/projects/{project_id}/evaluation-suites/{suite_id}/preview`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer
- TypeScript: <https://skmtc.dev/pioneer/apis/brain-api/docs/v1/projects/:project_id/evaluation-suites/:suite_id/preview/get.ts> (a function with typed inputs; its response is checked against the schema)

Preview pinned canonical suite cases before running models.

Args:
    project_id: Owning project.
    suite_id: Evaluation Suite ID.
    auth: Authenticated requester.

Returns:
    Suite metadata plus up to 25 pinned canonical cases.

Raises:
    HTTPException: If project or suite access is denied.

## Path parameters

- `project_id` string, required
- `suite_id` string, required

## Response `200`

Successful Response

- EvaluationSuitePreviewResponse: Canonical cases and metadata previewed before executing a suite.
  - `suite` EvaluationSuiteResponse, required: A project-owned pinned Evaluation Suite.
    - `id` string, required
    - `project_id` string, required
    - `dataset_id` string, required
    - `name` string, required
    - `task_type` string, required
    - `source_kind` 'agent_generated' | 'huggingface' | 'platform_catalog' | 'upload', required
    - `source_provenance` JsonObjectOutput, required
    - `field_mapping` JsonObjectOutput, required
    - `scorer_kind` 'harness' | 'llmaj' | 'native', required
    - `scorer_config` JsonObjectOutput, required
    - `case_count` integer, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
  - `columns` string[], required
  - `cases` object[], required

## Other responses

- `404`: Project or Evaluation Suite not found.
- `422`: Validation Error

## Changes

- **2026-09-24** `0e5e86e2bae5`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/pioneer/apis/brain-api/changes/v1/projects/:project_id/evaluation-suites/:suite_id/preview/get.md)

---

[API](https://skmtc.dev/pioneer/apis/brain-api.md) - [All operations](https://skmtc.dev/pioneer/apis/brain-api/llms.txt) - [OpenAPI document](https://skmtc.dev/pioneer/apis/brain-api/revisions/0e5e86e2bae5?raw)