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

Update an annotation queue

Updates a queue's name/description/rubric/status. queueId + projectId required; other fields optional (description nullable to clear).

Authentication

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

Request body required

Example

{
  "queueId": "00000000-0000-0000-0000-000000000000",
  "projectId": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "description": "string",
  "rubricItems": [
    {
      "name": "string",
      "description": "string",
      "scale_min": 0,
      "scale_max": 0,
      "weight": 0
    }
  ],
  "status": "active"
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "queueId": {
          "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)$"
        },
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 200
        },
        "description": {
          "nullable": true,
          "type": "string",
          "maxLength": 2000
        },
        "rubricItems": {
          "maxItems": 100,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              },
              "description": {
                "type": "string",
                "minLength": 1,
                "maxLength": 2000
              },
              "scale_min": {
                "type": "number"
              },
              "scale_max": {
                "type": "number"
              },
              "weight": {
                "type": "number",
                "minimum": 0,
                "maximum": 100
              }
            },
            "required": [
              "name",
              "description",
              "scale_min",
              "scale_max"
            ],
            "additionalProperties": false
          }
        },
        "status": {
          "type": "string",
          "enum": [
            "active",
            "paused",
            "completed"
          ]
        }
      },
      "required": [
        "queueId",
        "projectId"
      ],
      "additionalProperties": false
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200Queue updated.
400(no description)
401(no description)
404Annotation queue not found.
429(no description)

Code samples

cURL

curl -X PATCH \
  https://evalguard.ai/api/v1/annotations/queues \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "queueId": "00000000-0000-0000-0000-000000000000", "projectId": "00000000-0000-0000-0000-000000000000", "name": "string", "description": "string", "rubricItems": [ { "name": "string", "description": "string", "scale_min": 0, "scale_max": 0, "weight": 0 } ], "status": "active" }'

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",
  body: {
    "queueId": "00000000-0000-0000-0000-000000000000",
    "projectId": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "description": "string",
    "rubricItems": [
      {
        "name": "string",
        "description": "string",
        "scale_min": 0,
        "scale_max": 0,
        "weight": 0
      }
    ],
    "status": "active"
  },
});
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",
    body={
    "queueId": "00000000-0000-0000-0000-000000000000",
    "projectId": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "description": "string",
    "rubricItems": [
        {
            "name": "string",
            "description": "string",
            "scale_min": 0,
            "scale_max": 0,
            "weight": 0
        }
    ],
    "status": "active"
},
)
print(response)

Go

package main

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

func main() {
	body := strings.NewReader(`{"queueId":"00000000-0000-0000-0000-000000000000","projectId":"00000000-0000-0000-0000-000000000000","name":"string","description":"string","rubricItems":[{"name":"string","description":"string","scale_min":0,"scale_max":0,"weight":0}],"status":"active"}`)
	req, _ := http.NewRequestWithContext(context.Background(), "PATCH", "https://evalguard.ai/api/v1/annotations/queues", 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

400401404429

Other Evals endpoints