Update Annotation Queue

(v2)

PUT

Renames an annotation queue, replaces its tags, or attaches a different annotation form to it, and returns the queue. Send formId: null to detach the current form.

PUT/v2/annotation-queues/{annotationQueueId}

curl -X PUT "https://api.confident-ai.com/v2/annotation-queues/{annotationQueueId}" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Failed geography answers (2025)",
  "formId": "<ANNOTATION-FORM-ID>",
  "tags": [
    "geography",
    "week-13"
  ]
}'

200

{
  "success": true,
  "data": {
    "id": "<ANNOTATION-QUEUE-ID>",
    "name": "Failed geography answers",
    "type": "TRACE",
    "createdAt": "2025-01-15T10:30:00.000Z",
    "updatedAt": "2025-01-16T09:00:00.000Z",
    "formId": "<ANNOTATION-FORM-ID>",
    "tags": [
      "geography",
      "week-12"
    ],
    "totalItems": 40,
    "completedItems": 30,
    "pendingItems": 10,
    "completionPercentage": 75,
    "assignedItems": 24,
    "assignmentBreakdown": {
      "jane@acme.com": {
        "assigned": 12,
        "completed": 9
      }
    }
  },
  "link": "https://app.confident-ai.com/project/<PROJECT-ID>/annotation-queues/<ANNOTATION-QUEUE-ID>",
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Path parameters

annotationQueueIdstringRequired
The id of the annotation queue.

Request body

namestring
The new name of the queue, which must be unique in the project.
formIdstring | null
The id of an annotation form in this project to ask of every item in the queue. Forms are created and managed in the Confident AI platform. Send null to detach the current form.
tagslist of strings
Replaces the tags on the queue. Send an empty array to remove them all; omit it to leave them as they are.

Response

Update Annotation Queue succeeded.

successboolean
Indicates if the request was successful.
dataobject
A queue of production data your team annotates, with its progress and how the work is shared out.
Show 13 propertiesHide 13 properties
- idstring
  The id of the queue, generated by Confident AI.
- namestring
  The name of the queue, unique within the project.
- typeenum
  What a queue holds, fixed when it is created: TRACE, SPAN or THREAD queues are filled from your production data, while GOLDEN and TEST_CASE queues are filled by Confident AI. TEST_RUN is still accepted as an input alias for TEST_CASE.
  Show 5 enum valuesHide 5 enum values
  - TRACE
  - SPAN
  - THREAD
  - GOLDEN
  - TEST_CASE
- createdAtstring
  When the queue was created.
- updatedAtstring
  When the queue was last changed.
- formIdstring | null
  The id of the annotation form asked of every item in this queue, or null when the queue has no form.
- tagslist of strings
  The tags on the queue, for grouping and filtering the queues in your project.
- totalItemsinteger
  How many items the queue holds.
- completedItemsinteger
  How many of those items have been annotated.
- pendingItemsinteger
  How many items are still waiting to be annotated.
- completionPercentageinteger
  The share of the queue that has been annotated, from 0 to 100, rounded to a whole number.
- assignedItemsinteger
  How many items in the queue are assigned to a reviewer.
- assignmentBreakdownobject
  Each reviewer's share of the queue, keyed by their email address. Empty when no item is assigned.
linkstring
This is the URL of the resource on the Confident AI platform.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI