Annotation Queues

Update an annotation queue

Changed on

Partially updates an existing annotation queue. Setting project_id clears the legacy human_review_ids selection.

patch/v2/annotation-queues/{annotation_queue_id}

Request

  • Base URL
    https://my.orq.ai
  • URL
    https://my.orq.ai/v2/annotation-queues/{annotation_queue_id}
  • Auth
    HTTP bearer

Path parameters

annotation_queue_idstring required

Request body

display_namestring

Optional. New display name.

descriptionstring

Optional. New description.

project_idstring

Optional. New project. Setting this clears the legacy human_review_ids selection.

human_review_idsstring[]

Legacy: update manually selected human review IDs. Only applied when project_id is not set.

Response

OK

_idstring required

Unique annotation queue identifier assigned by ORQ.

display_namestring required

The display name of the annotation queue.

descriptionstring required

The description of the annotation queue.

workspace_idstring required

The unique identifier of the workspace it belongs to.

project_idstring

The project ID. When set, human reviews are resolved from the project automatically.

human_review_idsstring[] required

Legacy: manually selected human review IDs. Used only when project_id is not set.

created_by_idstring

The account that created the annotation queue. Unset when created via API key authentication.

updated_by_idstring

The account that last updated the annotation queue. Unset when updated via API key authentication.

createdstring date-time

The date and time the annotation queue was created.

updatedstring date-time

The date and time the annotation queue was last updated.

Changes