Annotation Queues

List annotation queues

Changed on

List annotation queues the user has access to.

get/v2/annotation-queues

Request

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

Query parameters

space_idstring

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

Example:RW50aXR5OjEyMzQ1

Filter search results to a particular space ID

space_namestring

Case-insensitive substring filter on the space name. Narrows results to resources in spaces whose name contains the given string. If omitted, no space name filtering is applied and all resources are returned.

namestring

Case-insensitive substring filter on the resource name. Returns only resources whose name contains the given string. For example, name=prod matches "production", "my-prod-dataset", etc. If omitted, no name filtering is applied and all resources are returned.

limitinteger

Maximum items to return. Defaults to 50 if omitted; maximum is 100.

cursorstring

Opaque pagination cursor returned from a previous response (pagination.next_cursor). Treat it as an unreadable token; do not attempt to parse or construct it.

Response

Returns a list of annotation queue objects

Example response

{
  "annotation_queues": [
    {
      "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_list removed and replaced with list_annotation_queues

    • info

      added 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