PATCH/api/v1/annotations/queues/items

Update queue item state

Mark a queue item as in-progress, completed, or skipped. Used by the rater UI as raters work through a queue.

Authentication

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

Request body required

Example

{
  "item_id": "00000000-0000-0000-0000-000000000000",
  "state": "pending"
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "required": [
        "item_id",
        "state"
      ],
      "properties": {
        "item_id": {
          "type": "string",
          "format": "uuid"
        },
        "state": {
          "type": "string",
          "enum": [
            "pending",
            "in_progress",
            "completed",
            "skipped"
          ]
        }
      }
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200Item updated.
400(no description)
401(no description)
403Forbidden — insufficient role for this operation.
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 '{ "item_id": "00000000-0000-0000-0000-000000000000", "state": "pending" }'

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: {
    "item_id": "00000000-0000-0000-0000-000000000000",
    "state": "pending"
  },
});
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={
    "item_id": "00000000-0000-0000-0000-000000000000",
    "state": "pending"
},
)
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(), "PATCH", "/api/v1/annotations/queues/items", map[string]any{"item_id": "00000000-0000-0000-0000-000000000000", "state": "pending"})
	if err != nil { panic(err) }
	fmt.Println(resp)
}

Errors

400401403404429

Other Evals endpoints