Skip to content
POST/api/v1/annotations/export/rlhf

Export pairwise annotations as RLHF training data

Exports pairwise_items + comparisons in an RLHF format (dpo/ppo-preference/reward-model/jsonl). All fields optional with defaults; returns JSON, or an NDJSON download when format='jsonl' or download=true.

Authentication

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

Request body required

Example

{
  "format": "dpo",
  "minAgreement": 0.6,
  "includeMetadata": true,
  "projectId": "00000000-0000-0000-0000-000000000000",
  "download": false,
  "limit": 5000
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "format": {
          "default": "dpo",
          "type": "string",
          "enum": [
            "dpo",
            "ppo-preference",
            "reward-model",
            "jsonl"
          ]
        },
        "minAgreement": {
          "default": 0.6,
          "type": "number",
          "minimum": 0,
          "maximum": 1
        },
        "includeMetadata": {
          "default": true,
          "type": "boolean"
        },
        "projectId": {
          "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)$"
        },
        "download": {
          "type": "boolean"
        },
        "limit": {
          "default": 5000,
          "type": "integer",
          "minimum": 1,
          "maximum": 50000
        }
      },
      "required": [
        "format",
        "minAgreement",
        "includeMetadata",
        "limit"
      ],
      "additionalProperties": false
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200JSON export {format,count,truncated,limit,data}, or an NDJSON file download (jsonl/download).
400(no description)
401(no description)
429(no description)

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/annotations/export/rlhf \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "format": "dpo", "minAgreement": 0.6, "includeMetadata": true, "projectId": "00000000-0000-0000-0000-000000000000", "download": false, "limit": 5000 }'

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/export/rlhf",
  body: {
    "format": "dpo",
    "minAgreement": 0.6,
    "includeMetadata": true,
    "projectId": "00000000-0000-0000-0000-000000000000",
    "download": false,
    "limit": 5000
  },
});
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/export/rlhf",
    body={
    "format": "dpo",
    "minAgreement": 0.6,
    "includeMetadata": True,
    "projectId": "00000000-0000-0000-0000-000000000000",
    "download": False,
    "limit": 5000
},
)
print(response)

Go

package main

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

func main() {
	body := strings.NewReader(`{"format":"dpo","minAgreement":0.6,"includeMetadata":true,"projectId":"00000000-0000-0000-0000-000000000000","download":false,"limit":5000}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/annotations/export/rlhf", 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

400401429

Other Compliance endpoints