---
title: "Run evaluation"
method: POST
path: "/v1/retrievers/{retriever_id}/evaluations"
tags: ["Retriever Evaluations"]
---

# Run evaluation

`POST /v1/retrievers/{retriever_id}/evaluations`

## Request

- Base URL: `https://api.mixpeek.com`
- URL: `https://api.mixpeek.com/v1/retrievers/{retriever_id}/evaluations`
- Auth: HTTP bearer and API key in header `X-Namespace`

Evaluate a retriever's quality using a ground truth dataset. Returns immediately with a task ID - evaluation runs asynchronously.

## Path parameters

- `retriever_id` string, required

## Request body

- StartEvaluationRequest: Request to start an evaluation.
  - `dataset_name` string, required: Name of the evaluation dataset to use
  - `evaluation_config` EvaluationConfig: Configuration for an evaluation run.
    - `k_values` integer[], nullable: K values for Precision@K, Recall@K, NDCG@K, etc.
    - `metrics` string[], nullable: List of metrics to calculate. Available: precision, recall, f1, f2, map, ndcg, mrr. f2 is the recall-weighted F-beta (beta=2) — useful when missing a relevant doc costs more than a false positive.

## Response `202`

Successful Response

- StartEvaluationResponse: Response when starting an evaluation.
  - `task_id` string, required: Task ID for tracking progress
  - `evaluation_id` string, required: Evaluation ID
  - `task_type` string: Task type
  - `status` string: Initial status
  - `created_at` string, required: Creation timestamp

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `422`: Unprocessable Entity
- `429`: Too Many Requests
- `500`: Internal Server Error
- `503`: Service Unavailable

## Changes

- **2026-10-09** `61a175e8eb9a`: 1 warning, 5 info
  - removed the optional property `detail` from the response with the `422` status
  - added the non-success response with the status `429`
  - added the non-success response with the status `503`
  - added the optional property `success` to the response with the `422` status
  - …2 more
- **2026-08-09** `5d4c905106b4`: 1 info
  - the endpoint scheme security `BearerAuth AND NamespaceHeader` was added to the API

[Operation history](https://skmtc.dev/mixpeek/apis/mixpeek-api/changes/v1/retrievers/:retriever_id/evaluations/post.md)

---

[API](https://skmtc.dev/mixpeek/apis/mixpeek-api.md) - [All operations](https://skmtc.dev/mixpeek/apis/mixpeek-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mixpeek/apis/mixpeek-api/revisions/790bc16455f6?raw)