Skip to content
POST/api/v1/annotations/pairwise

Create a pairwise item or record a comparison

Action-discriminated. action='create' (default) creates a pairwise_item (requires input/outputA/outputB/providerA/providerB); action='compare' records a vote (requires itemId + winner A/B/tie).

Authentication

Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/api-keys.

Request body required

Example

{
  "action": "create",
  "input": "string",
  "outputA": "string",
  "outputB": "string",
  "providerA": "string",
  "providerB": "string",
  "modelA": "string",
  "modelB": "string",
  "projectId": "00000000-0000-0000-0000-000000000000",
  "metadata": {},
  "itemId": "00000000-0000-0000-0000-000000000000",
  "winner": "A",
  "reason": "string"
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "action": {
          "default": "create",
          "type": "string",
          "enum": [
            "create",
            "vote",
            "skip",
            "compare"
          ]
        },
        "input": {
          "type": "string",
          "minLength": 1,
          "maxLength": 50000
        },
        "outputA": {
          "type": "string",
          "minLength": 1,
          "maxLength": 50000
        },
        "outputB": {
          "type": "string",
          "minLength": 1,
          "maxLength": 50000
        },
        "providerA": {
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "providerB": {
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "modelA": {
          "type": "string",
          "maxLength": 200
        },
        "modelB": {
          "type": "string",
          "maxLength": 200
        },
        "projectId": {
          "nullable": true,
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "metadata": {
          "type": "object",
          "additionalProperties": {}
        },
        "itemId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "winner": {
          "type": "string",
          "enum": [
            "A",
            "B",
            "tie"
          ]
        },
        "reason": {
          "type": "string",
          "maxLength": 2000
        }
      },
      "required": [
        "action"
      ],
      "additionalProperties": {}
    }
  }
}

Response

201 example

{
  "success": true
}

All status codes

201Pairwise item created or comparison recorded.
400(no description)
401(no description)
403No organization found (create).
429(no description)

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/annotations/pairwise \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "action": "create", "input": "string", "outputA": "string", "outputB": "string", "providerA": "string", "providerB": "string", "modelA": "string", "modelB": "string", "projectId": "00000000-0000-0000-0000-000000000000", "metadata": {}, "itemId": "00000000-0000-0000-0000-000000000000", "winner": "A", "reason": "string" }'

TypeScript

import { EvalGuard } from "@evalguard/sdk";

const client = new EvalGuard({ apiKey: process.env.EVALGUARD_API_KEY });

const response = await client.request({
  method: "POST",
  path: "/api/v1/annotations/pairwise",
  body: {
    "action": "create",
    "input": "string",
    "outputA": "string",
    "outputB": "string",
    "providerA": "string",
    "providerB": "string",
    "modelA": "string",
    "modelB": "string",
    "projectId": "00000000-0000-0000-0000-000000000000",
    "metadata": {},
    "itemId": "00000000-0000-0000-0000-000000000000",
    "winner": "A",
    "reason": "string"
  },
});
console.log(response);

Python

from evalguard import EvalGuard
import os

client = EvalGuard(api_key=os.environ["EVALGUARD_API_KEY"])

response = client.request(
    method="POST",
    path="/api/v1/annotations/pairwise",
    body={
    "action": "create",
    "input": "string",
    "outputA": "string",
    "outputB": "string",
    "providerA": "string",
    "providerB": "string",
    "modelA": "string",
    "modelB": "string",
    "projectId": "00000000-0000-0000-0000-000000000000",
    "metadata": {},
    "itemId": "00000000-0000-0000-0000-000000000000",
    "winner": "A",
    "reason": "string"
},
)
print(response)

Go

package main

import (
	"context"
	"fmt"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{"action":"create","input":"string","outputA":"string","outputB":"string","providerA":"string","providerB":"string","modelA":"string","modelB":"string","projectId":"00000000-0000-0000-0000-000000000000","metadata":{},"itemId":"00000000-0000-0000-0000-000000000000","winner":"A","reason":"string"}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/annotations/pairwise", body)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("EVALGUARD_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	fmt.Println(resp.Status)
}

Errors

400401403429

Other Evals endpoints