POST/api/v1/annotations

Create an annotation

Creates a new annotation (single-target or pairwise). Mass-assignment-safe (ADR-0017): only target_id, target_type, score, label, comment, and queue_id are accepted.

Authentication

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

Request body required

Example

{
  "target_id": "string",
  "target_type": "eval_case",
  "score": 0,
  "label": "string",
  "comment": "string",
  "queue_id": "00000000-0000-0000-0000-000000000000"
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "required": [
        "target_id",
        "target_type"
      ],
      "properties": {
        "target_id": {
          "type": "string"
        },
        "target_type": {
          "type": "string",
          "enum": [
            "eval_case",
            "trace",
            "pairwise"
          ]
        },
        "score": {
          "type": "number"
        },
        "label": {
          "type": "string"
        },
        "comment": {
          "type": "string"
        },
        "queue_id": {
          "type": "string",
          "format": "uuid"
        }
      }
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200Annotation created.
400(no description)
401(no description)
429(no description)

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/annotations \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "target_id": "string", "target_type": "eval_case", "score": 0, "label": "string", "comment": "string", "queue_id": "00000000-0000-0000-0000-000000000000" }'

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",
  body: {
    "target_id": "string",
    "target_type": "eval_case",
    "score": 0,
    "label": "string",
    "comment": "string",
    "queue_id": "00000000-0000-0000-0000-000000000000"
  },
});
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",
    body={
    "target_id": "string",
    "target_type": "eval_case",
    "score": 0,
    "label": "string",
    "comment": "string",
    "queue_id": "00000000-0000-0000-0000-000000000000"
},
)
print(response)

Go

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/evalguard/evalguard-go"
)

func main() {
	client := evalguard.NewClient(os.Getenv("EVALGUARD_API_KEY"))
	resp, err := client.Request(context.Background(), "POST", "/api/v1/annotations", map[string]any{"target_id": "string", "target_type": "eval_case", "score": 0, "label": "string", "comment": "string", "queue_id": "00000000-0000-0000-0000-000000000000"})
	if err != nil { panic(err) }
	fmt.Println(resp)
}

Errors

400401429

Other Evals endpoints