Skip to content
PATCH/api/v1/annotations/queues/items

Review, skip, or unlock a queue item

Submits a review / skips / unlocks a claimed item. itemId, projectId, action required. For action='review', score or overallScore is required; feedback optional.

Authentication

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

Request body required

Example

{
  "itemId": "00000000-0000-0000-0000-000000000000",
  "projectId": "00000000-0000-0000-0000-000000000000",
  "action": "review",
  "score": {},
  "overallScore": 0,
  "feedback": "string"
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "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)$"
        },
        "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)$"
        },
        "action": {
          "type": "string",
          "enum": [
            "review",
            "skip",
            "unlock"
          ]
        },
        "score": {
          "type": "object",
          "additionalProperties": {
            "type": "number"
          },
          "description": "Rubric scores; required (or overallScore) for action=review."
        },
        "overallScore": {
          "type": "number"
        },
        "feedback": {
          "type": "string",
          "maxLength": 20000
        }
      },
      "required": [
        "itemId",
        "projectId",
        "action"
      ],
      "additionalProperties": false
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200Item reviewed/skipped/unlocked.
400(no description)
401(no description)
403You do not hold the lock (unlock).
404(no description)
429(no description)

Code samples

cURL

curl -X PATCH \
  https://evalguard.ai/api/v1/annotations/queues/items \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "itemId": "00000000-0000-0000-0000-000000000000", "projectId": "00000000-0000-0000-0000-000000000000", "action": "review", "score": {}, "overallScore": 0, "feedback": "string" }'

TypeScript

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

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

const response = await client.request({
  method: "PATCH",
  path: "/api/v1/annotations/queues/items",
  body: {
    "itemId": "00000000-0000-0000-0000-000000000000",
    "projectId": "00000000-0000-0000-0000-000000000000",
    "action": "review",
    "score": {},
    "overallScore": 0,
    "feedback": "string"
  },
});
console.log(response);

Python

from evalguard import EvalGuard
import os

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

response = client.request(
    method="PATCH",
    path="/api/v1/annotations/queues/items",
    body={
    "itemId": "00000000-0000-0000-0000-000000000000",
    "projectId": "00000000-0000-0000-0000-000000000000",
    "action": "review",
    "score": {},
    "overallScore": 0,
    "feedback": "string"
},
)
print(response)

Go

package main

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

func main() {
	body := strings.NewReader(`{"itemId":"00000000-0000-0000-0000-000000000000","projectId":"00000000-0000-0000-0000-000000000000","action":"review","score":{},"overallScore":0,"feedback":"string"}`)
	req, _ := http.NewRequestWithContext(context.Background(), "PATCH", "https://evalguard.ai/api/v1/annotations/queues/items", 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

400401403404429

Other Evals endpoints