Create evaluation dataset

curl --request POST \
  --url https://api.mixpeek.com/v1/retrievers/evaluations/datasets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Namespace: <api-key>' \
  --data '
{
  "dataset_name": "<string>",
  "queries": [
    {
      "query_id": "<string>",
      "query_input": {},
      "relevant_documents": [
        "<string>"
      ],
      "relevance_scores": {}
    }
  ],
  "description": "<string>",
  "metadata": {}
}
'

import requests

url = "https://api.mixpeek.com/v1/retrievers/evaluations/datasets"

payload = {
    "dataset_name": "<string>",
    "queries": [
        {
            "query_id": "<string>",
            "query_input": {},
            "relevant_documents": ["<string>"],
            "relevance_scores": {}
        }
    ],
    "description": "<string>",
    "metadata": {}
}
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>',
    queries: [
      {
        query_id: '<string>',
        query_input: {},
        relevant_documents: ['<string>'],
        relevance_scores: {}
      }
    ],
    description: '<string>',
    metadata: {}
  })
};

fetch('https://api.mixpeek.com/v1/retrievers/evaluations/datasets', 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/evaluations/datasets",
  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>',
    'queries' => [
        [
                'query_id' => '<string>',
                'query_input' => [
                                
                ],
                'relevant_documents' => [
                                '<string>'
                ],
                'relevance_scores' => [
                                
                ]
        ]
    ],
    'description' => '<string>',
    'metadata' => [
        
    ]
  ]),
  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/evaluations/datasets"

	payload := strings.NewReader("{\n  \"dataset_name\": \"<string>\",\n  \"queries\": [\n    {\n      \"query_id\": \"<string>\",\n      \"query_input\": {},\n      \"relevant_documents\": [\n        \"<string>\"\n      ],\n      \"relevance_scores\": {}\n    }\n  ],\n  \"description\": \"<string>\",\n  \"metadata\": {}\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/evaluations/datasets")
  .header("Authorization", "Bearer <token>")
  .header("X-Namespace", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dataset_name\": \"<string>\",\n  \"queries\": [\n    {\n      \"query_id\": \"<string>\",\n      \"query_input\": {},\n      \"relevant_documents\": [\n        \"<string>\"\n      ],\n      \"relevance_scores\": {}\n    }\n  ],\n  \"description\": \"<string>\",\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"queries\": [\n    {\n      \"query_id\": \"<string>\",\n      \"query_input\": {},\n      \"relevant_documents\": [\n        \"<string>\"\n      ],\n      \"relevance_scores\": {}\n    }\n  ],\n  \"description\": \"<string>\",\n  \"metadata\": {}\n}"

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

{
  "dataset_id": "<string>",
  "dataset_name": "<string>",
  "queries": [
    {
      "query_id": "<string>",
      "query_input": {},
      "relevant_documents": [
        "<string>"
      ],
      "relevance_scores": {}
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "namespace_id": "<string>",
  "internal_id": "<string>",
  "query_count": 123,
  "description": "<string>",
  "metadata": {}
}

{
  "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

evaluations

datasets

Create evaluation dataset

curl --request POST \
  --url https://api.mixpeek.com/v1/retrievers/evaluations/datasets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Namespace: <api-key>' \
  --data '
{
  "dataset_name": "<string>",
  "queries": [
    {
      "query_id": "<string>",
      "query_input": {},
      "relevant_documents": [
        "<string>"
      ],
      "relevance_scores": {}
    }
  ],
  "description": "<string>",
  "metadata": {}
}
'

import requests

url = "https://api.mixpeek.com/v1/retrievers/evaluations/datasets"

payload = {
    "dataset_name": "<string>",
    "queries": [
        {
            "query_id": "<string>",
            "query_input": {},
            "relevant_documents": ["<string>"],
            "relevance_scores": {}
        }
    ],
    "description": "<string>",
    "metadata": {}
}
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>',
    queries: [
      {
        query_id: '<string>',
        query_input: {},
        relevant_documents: ['<string>'],
        relevance_scores: {}
      }
    ],
    description: '<string>',
    metadata: {}
  })
};

fetch('https://api.mixpeek.com/v1/retrievers/evaluations/datasets', 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/evaluations/datasets",
  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>',
    'queries' => [
        [
                'query_id' => '<string>',
                'query_input' => [
                                
                ],
                'relevant_documents' => [
                                '<string>'
                ],
                'relevance_scores' => [
                                
                ]
        ]
    ],
    'description' => '<string>',
    'metadata' => [
        
    ]
  ]),
  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/evaluations/datasets"

	payload := strings.NewReader("{\n  \"dataset_name\": \"<string>\",\n  \"queries\": [\n    {\n      \"query_id\": \"<string>\",\n      \"query_input\": {},\n      \"relevant_documents\": [\n        \"<string>\"\n      ],\n      \"relevance_scores\": {}\n    }\n  ],\n  \"description\": \"<string>\",\n  \"metadata\": {}\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/evaluations/datasets")
  .header("Authorization", "Bearer <token>")
  .header("X-Namespace", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dataset_name\": \"<string>\",\n  \"queries\": [\n    {\n      \"query_id\": \"<string>\",\n      \"query_input\": {},\n      \"relevant_documents\": [\n        \"<string>\"\n      ],\n      \"relevance_scores\": {}\n    }\n  ],\n  \"description\": \"<string>\",\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"queries\": [\n    {\n      \"query_id\": \"<string>\",\n      \"query_input\": {},\n      \"relevant_documents\": [\n        \"<string>\"\n      ],\n      \"relevance_scores\": {}\n    }\n  ],\n  \"description\": \"<string>\",\n  \"metadata\": {}\n}"

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

{
  "dataset_id": "<string>",
  "dataset_name": "<string>",
  "queries": [
    {
      "query_id": "<string>",
      "query_input": {},
      "relevant_documents": [
        "<string>"
      ],
      "relevance_scores": {}
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "namespace_id": "<string>",
  "internal_id": "<string>",
  "query_count": 123,
  "description": "<string>",
  "metadata": {}
}

{
  "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.

Body

application/json

Request model for creating a new evaluation dataset.

dataset_name

string

required

Unique name for this dataset

Required string length: 1 - 200

queries

GroundTruthQuery · object[]

required

List of queries with ground truth relevance labels

Minimum array length: 1

Show child attributes

description

string | null

Description of what this dataset measures

metadata

Metadata · object | null

Additional metadata

Response

Successful Response

Complete evaluation dataset with metadata.

An evaluation dataset is a collection of queries with ground truth relevance labels, used to measure retriever quality.

dataset_id

string

required

Unique dataset identifier

dataset_name

string

required

Human-readable dataset name

queries

GroundTruthQuery · object[]

required

List of queries with ground truth

Show child attributes

created_at

string<date-time>

required

When dataset was created

updated_at

string<date-time>

required

Last update timestamp

namespace_id

string

required

Namespace this dataset belongs to

internal_id

string

required

Internal organization ID

query_count

integer

required

Number of queries in dataset

description

string | null

Dataset description

metadata

Metadata · object | null

Additional metadata (e.g., labeling instructions, version info)

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

Create evaluation dataset

Authorizations

Body

Response