Annotation Queue Update

Update an annotation queue’s metadata (name, description, scorer_refs).

PUT /annotation_queues/{queue_id}

Annotation Queue Update

cURL

curl --request PUT \
  --url https://api.example.com/annotation_queues/{queue_id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "<string>",
  "name": "Updated Queue Name",
  "description": "Updated description",
  "scorer_refs": [
    "weave:///entity/project/scorer/error_severity:abc123",
    "weave:///entity/project/scorer/resolution_quality:def456"
  ]
}
'

200

{
  "queue": {
    "id": "<string>",
    "project_id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "scorer_refs": [
      "<string>"
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

queue_id · string · required

Body

application/json

Request body for updating an annotation queue (queue_id comes from path).

All fields except project_id are optional - only provided fields will be updated.

project_id · string · required

Example:

"entity/project"

name · string | null

Example:

"Updated Queue Name"

description · string | null

Example:

"Updated description"

scorer_refs · string[] | null

Example:

[
  "weave:///entity/project/scorer/error_severity:abc123",
  "weave:///entity/project/scorer/resolution_quality:def456"
]

Response

200

application/json

Successful Response

Response from updating an annotation queue.

queue · AnnotationQueueSchema · object · required

Schema for annotation queue responses.

Show child attributes