Skip to main content
POST
/
v2
/
annotation-queues
/
{annotation_queue_id}
/
records
/
{annotation_queue_record_id}
/
assign
Assign users to a record
curl --request POST \
  --url https://api.arize.com/v2/annotation-queues/{annotation_queue_id}/records/{annotation_queue_record_id}/assign \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assigned_user_emails": [
    "reviewer@example.com"
  ]
}
'
{
  "id": "aqr_001",
  "annotation_queue_id": "aq_abc123",
  "source_type": "spans",
  "assigned_users": [
    {
      "user": {
        "id": "usr_123",
        "email": "reviewer@example.com"
      },
      "completion_status": "pending"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Most Arize AI endpoints require authentication. For those endpoints that require authentication, include your API key in the request header using the format

Path Parameters

​
annotation_queue_id
string
required

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

Example:

"RW50aXR5OjEyMzQ1"

​
annotation_queue_record_id
string
required

The unique annotation queue record identifier (base64) A universally unique identifier (base64-encoded opaque string).

Example:

"RW50aXR5OjEyMzQ1"

Body

application/json

Body containing the user assignment for an annotation queue record

User assignment for an annotation queue record. Fully replaces the current record-level user assignment. Pass an empty array to remove all assignments.

​
assigned_user_emails
string<email>[]
required

Emails of users to assign to this record. Replaces the current record-level user assignment entirely. At most 100 emails may be provided per request.

Maximum array length: 100

An email address

Example:
[
  "reviewer@example.com",
  "annotator@example.com"
]

Response

Returns a snapshot of the record fields updated by the assign operation. Only the resulting user assignments are included. Annotations and evaluations are omitted; use the list records endpoint for the full record state.

A snapshot of the annotation queue record fields that were modified by an assign operation. Only the record identity fields and the resulting user assignments are returned. Annotations and evaluations are not fetched and are not included in this response for performance reasons; use the list records endpoint to retrieve the full record state.

​
id
string
required

The unique identifier for the record

​
annotation_queue_id
string
required

The annotation queue this record belongs to

​
source_type
enum<string>
required

Source type of the annotation queue record.

  • spans - The record originates from span data.
  • dataset - The record originates from a dataset example.
Available options:
spans,
dataset
​
assigned_users
object[]
required

The users now assigned to this record after this operation