Annotation Queues

Get an annotation queue

Changed on

Get an annotation queue object by its ID.

This includes the annotation queue's annotation configs, which define the structure of annotations that can be created in this queue.

This endpoint does not include queue records or annotation progress. To manage records in a queue, use the Annotation Queue Items endpoints.

get/v2/annotation-queues/{annotation_queue_id}

Request

  • Base URL
    https://api.arize.com
  • URL
    https://api.arize.com/v2/annotation-queues/{annotation_queue_id}
  • Auth
    HTTP bearer

Path parameters

annotation_queue_idstring required

A universally unique identifier (base64-encoded opaque string).

Example:RW50aXR5OjEyMzQ1

The unique annotation queue identifier (base64)

Response

An annotation queue object

idstring required

The unique identifier for the annotation queue

namestring required

The name of the annotation queue

space_idstring required

The space id the annotation queue belongs to

instructionsstring nullable

The instructions for the annotation queue

created_atstring date-time required

The timestamp for when the annotation queue was created

updated_atstring date-time required

The timestamp for when the annotation queue was last updated

column_allowliststring[] nullable

The record column names annotators assigned to this queue are allowed to see. Absent or null means the queue is unrestricted and annotators see every column.

Example response

{
  "id": "aq_abc123",
  "name": "Quality Review Queue",
  "space_id": "spc_xyz789",
  "instructions": "Review each response for accuracy and helpfulness",
  "annotators": [
    {
      "email": "user@example.com"
    }
  ],
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-20T14:45:00Z",
  "column_allowlist": [
    "context.trace_id",
    "attributes.llm.input_messages",
    "column with spaces"
  ]
}

Changes

    • info

      added the optional property to the response with the status

    • breaking

      the ///// response's property type changed from no type to object for status

    • breaking

      the ///// response's property type changed from no type to object for status

    • breaking

      the ///// response's property type changed from no type to object for status

    • info

      api operation id annotation_queues_get removed and replaced with get_annotation_queue

    • info

      removed the non-success response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      removed subschema #2 from the ///// response property allOf list for the response status

    • info

      removed subschema #2 from the ///// response property allOf list for the response status

    • info

      removed subschema #2 from the ///// response property allOf list for the response status

    • info

      added CONTINUOUS CATEGORICAL FREEFORM discriminator mapping keys to the / response property for the response status

    • info

      removed continuous categorical freeform discriminator mapping keys from the / response property for the response status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status