Update Queue

PUThttps://api.confident-ai.com/v2/annotation-queues/{annotationQueueId}

Renames an annotation queue 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>"
}'

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",
    "testRunId": null,
    "formId": "<ANNOTATION-FORM-ID>",
    "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 to ask of every item in the queue. Send null to detach the current form.

Response

Update 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_RUN queues are filled by Confident AI.
  Show 5 enum valuesHide 5 enum values
  - TRACE
  - SPAN
  - THREAD
  - GOLDEN
  - TEST_RUN
- createdAtstring
  When the queue was created.
- updatedAtstring
  When the queue was last changed.
- testRunIdstring | null
  The id of the test run this queue reviews, for a queue Confident AI created from a test run. Null for a queue you created.
- formIdstring | null
  The id of the annotation form asked of every item in this queue, or null when annotators only rate the criteria.
- 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