Skip to content
POST/api/v1/annotation-queues/{queueId}/claim-next

Atomically claim the next unlocked item in a queue

Picks the oldest unlocked + uncompleted item, locks it to the caller for lockMinutes (default 15), and returns the item + rubric_items. Stale locks (older than TTL) are auto-swept before each claim. Retries up to 3x on race; 409 CLAIM_CONFLICT if contention exhausts attempts.

Authentication

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

Parameters

queueId in pathrequired
string

Request body

Example

{
  "lockMinutes": 15
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "lockMinutes": {
          "type": "integer",
          "minimum": 1,
          "maximum": 120,
          "default": 15
        }
      }
    }
  }
}

Response

All status codes

200{claimed: item, rubric, lockExpiresAt, attempt} or {claimed: null, reason: 'queue-empty'}
400(no description)
401(no description)
403Forbidden — the credential is valid but lacks the API-key scope, member role, or plan entitlement this operation requires.
409CLAIM_CONFLICT after exhausting retries
429(no description)
500DB_ERROR

Code samples

cURL

# {queueId} is shown with an EXAMPLE value — replace it with real values.
curl -X POST \
  https://evalguard.ai/api/v1/annotation-queues/00000000-0000-0000-0000-000000000000/claim-next \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "lockMinutes": 15 }'

TypeScript

// The TypeScript SDK (@evalguard/sdk) exposes TYPED methods — runEval,
// getEval, runSecurityScan, checkFirewall, … — not a generic request().
// For an arbitrary endpoint, call it directly:
// {queueId} is shown with an EXAMPLE value — replace it with real values.

const res = await fetch("https://evalguard.ai/api/v1/annotation-queues/00000000-0000-0000-0000-000000000000/claim-next", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "lockMinutes": 15
  }),
});
console.log(res.status, await res.json());

Python

# The Python SDK (pip install evalguardai) exposes TYPED methods on
# EvalGuardClient — run_eval, get_eval, … — not a generic request().
# For an arbitrary endpoint, call it directly:
# {queueId} is shown with an EXAMPLE value — replace it with real values.

import os
import requests

headers = {"Authorization": f"Bearer {os.environ['EVALGUARD_API_KEY']}"}
headers["Content-Type"] = "application/json"

response = requests.request(
    "POST",
    "https://evalguard.ai/api/v1/annotation-queues/00000000-0000-0000-0000-000000000000/claim-next",
    headers=headers,
    json={
    "lockMinutes": 15
},
)
print(response.status_code, response.json())

Go

package main

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

// {queueId} is shown with an EXAMPLE value — replace it with real values.
func main() {
	body := strings.NewReader(`{"lockMinutes":15}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/annotation-queues/00000000-0000-0000-0000-000000000000/claim-next", 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

400401403409429500

Other Annotations endpoints