Run evaluation

curl --request POST \
  --url https://api.mixpeek.com/v1/retrievers/{retriever_id}/evaluations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Namespace: <api-key>' \
  --data '
{
  "dataset_name": "<string>",
  "evaluation_config": {
    "k_values": [
      1,
      5,
      10,
      20
    ],
    "metrics": [
      "precision",
      "recall",
      "f1",
      "map",
      "ndcg",
      "mrr"
    ]
  }
}
'

import requests

url = "https://api.mixpeek.com/v1/retrievers/{retriever_id}/evaluations"

payload = {
    "dataset_name": "<string>",
    "evaluation_config": {
        "k_values": [1, 5, 10, 20],
        "metrics": ["precision", "recall", "f1", "map", "ndcg", "mrr"]
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "X-Namespace": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'X-Namespace': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    dataset_name: '<string>',
    evaluation_config: {
      k_values: [1, 5, 10, 20],
      metrics: ['precision', 'recall', 'f1', 'map', 'ndcg', 'mrr']
    }
  })
};

fetch('https://api.mixpeek.com/v1/retrievers/{retriever_id}/evaluations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mixpeek.com/v1/retrievers/{retriever_id}/evaluations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'dataset_name' => '<string>',
    'evaluation_config' => [
        'k_values' => [
                1,
                5,
                10,
                20
        ],
        'metrics' => [
                'precision',
                'recall',
                'f1',
                'map',
                'ndcg',
                'mrr'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Namespace: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mixpeek.com/v1/retrievers/{retriever_id}/evaluations"

	payload := strings.NewReader("{\n  \"dataset_name\": \"<string>\",\n  \"evaluation_config\": {\n    \"k_values\": [\n      1,\n      5,\n      10,\n      20\n    ],\n    \"metrics\": [\n      \"precision\",\n      \"recall\",\n      \"f1\",\n      \"map\",\n      \"ndcg\",\n      \"mrr\"\n    ]\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Namespace", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.mixpeek.com/v1/retrievers/{retriever_id}/evaluations")
  .header("Authorization", "Bearer <token>")
  .header("X-Namespace", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dataset_name\": \"<string>\",\n  \"evaluation_config\": {\n    \"k_values\": [\n      1,\n      5,\n      10,\n      20\n    ],\n    \"metrics\": [\n      \"precision\",\n      \"recall\",\n      \"f1\",\n      \"map\",\n      \"ndcg\",\n      \"mrr\"\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mixpeek.com/v1/retrievers/{retriever_id}/evaluations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Namespace"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"dataset_name\": \"<string>\",\n  \"evaluation_config\": {\n    \"k_values\": [\n      1,\n      5,\n      10,\n      20\n    ],\n    \"metrics\": [\n      \"precision\",\n      \"recall\",\n      \"f1\",\n      \"map\",\n      \"ndcg\",\n      \"mrr\"\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "task_id": "<string>",
  "evaluation_id": "<string>",
  "created_at": "<string>",
  "task_type": "retriever.evaluation",
  "status": "pending"
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

POST

retrievers

{retriever_id}

evaluations

Run evaluation

curl --request POST \
  --url https://api.mixpeek.com/v1/retrievers/{retriever_id}/evaluations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Namespace: <api-key>' \
  --data '
{
  "dataset_name": "<string>",
  "evaluation_config": {
    "k_values": [
      1,
      5,
      10,
      20
    ],
    "metrics": [
      "precision",
      "recall",
      "f1",
      "map",
      "ndcg",
      "mrr"
    ]
  }
}
'

import requests

url = "https://api.mixpeek.com/v1/retrievers/{retriever_id}/evaluations"

payload = {
    "dataset_name": "<string>",
    "evaluation_config": {
        "k_values": [1, 5, 10, 20],
        "metrics": ["precision", "recall", "f1", "map", "ndcg", "mrr"]
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "X-Namespace": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'X-Namespace': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    dataset_name: '<string>',
    evaluation_config: {
      k_values: [1, 5, 10, 20],
      metrics: ['precision', 'recall', 'f1', 'map', 'ndcg', 'mrr']
    }
  })
};

fetch('https://api.mixpeek.com/v1/retrievers/{retriever_id}/evaluations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mixpeek.com/v1/retrievers/{retriever_id}/evaluations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'dataset_name' => '<string>',
    'evaluation_config' => [
        'k_values' => [
                1,
                5,
                10,
                20
        ],
        'metrics' => [
                'precision',
                'recall',
                'f1',
                'map',
                'ndcg',
                'mrr'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Namespace: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mixpeek.com/v1/retrievers/{retriever_id}/evaluations"

	payload := strings.NewReader("{\n  \"dataset_name\": \"<string>\",\n  \"evaluation_config\": {\n    \"k_values\": [\n      1,\n      5,\n      10,\n      20\n    ],\n    \"metrics\": [\n      \"precision\",\n      \"recall\",\n      \"f1\",\n      \"map\",\n      \"ndcg\",\n      \"mrr\"\n    ]\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Namespace", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.mixpeek.com/v1/retrievers/{retriever_id}/evaluations")
  .header("Authorization", "Bearer <token>")
  .header("X-Namespace", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dataset_name\": \"<string>\",\n  \"evaluation_config\": {\n    \"k_values\": [\n      1,\n      5,\n      10,\n      20\n    ],\n    \"metrics\": [\n      \"precision\",\n      \"recall\",\n      \"f1\",\n      \"map\",\n      \"ndcg\",\n      \"mrr\"\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mixpeek.com/v1/retrievers/{retriever_id}/evaluations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Namespace"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"dataset_name\": \"<string>\",\n  \"evaluation_config\": {\n    \"k_values\": [\n      1,\n      5,\n      10,\n      20\n    ],\n    \"metrics\": [\n      \"precision\",\n      \"recall\",\n      \"f1\",\n      \"map\",\n      \"ndcg\",\n      \"mrr\"\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "task_id": "<string>",
  "evaluation_id": "<string>",
  "created_at": "<string>",
  "task_type": "retriever.evaluation",
  "status": "pending"
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

Authorizations

Authorization

string

header

required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing header returns 403; an invalid or revoked key returns 401.

X-Namespace

string

header

required

Namespace id (ns_...), not the namespace name. This scopes the request rather than authenticating it, and it is required on every operation marked x-mixpeek-namespace-scoped.

Path Parameters

retriever_id

string

required

Body

application/json

Request to start an evaluation.

dataset_name

string

required

Name of the evaluation dataset to use

Minimum string length: 1

evaluation_config

EvaluationConfig · object | null

Optional evaluation configuration (uses defaults if not provided)

Show child attributes

Response

Successful Response

Response when starting an evaluation.

task_id

string

required

Task ID for tracking progress

evaluation_id

string

required

Evaluation ID

created_at

string

required

Creation timestamp

task_type

string

default:retriever.evaluation

Task type

status

string

default:pending

Initial status

Organization

Namespaces

Buckets

Feature Extractors

Batch Queue

Collections

Documents

Retrievers

Taxonomies

Clusters

Triggers

Alerts

Webhooks

Apps

Agent Sessions

Annotations

Templates

Manifest

Discovery

Analytics

Notifications

Tasks

Inference

Resource Search

Pricing

Events

Onboarding

Run evaluation

Authorizations

Path Parameters

Body

Response