COconfident-ai
Annotation Queues

Annotate Queue Item

Changed on

Annotates a single queue item, associating the work with the item's trace, span, or thread automatically. Supports both plain queues and queues with an attached form.

Submit criteria ratings (the flat rating fields or the annotations array) and, for form queues, custom-field answers (formResponses). At least one must be present.

Validation rules:

  • For thread items: Use expectedOutcome (not expectedOutput).
  • For trace/span items: Use expectedOutput (not expectedOutcome).
  • A criterion's name must match an available criterion — omit it for the default criterion, otherwise it must match a configured custom criterion or a form criteria field. A mismatched name is rejected.
  • Form formResponses are addressed by each field's visible label, accepted only for queues with an attached form.
  • Set markAsCompleted: false to leave the item open (default: true). For form queues, completing enforces the form's required fields.
post/v1/annotation-queues/{itemId}/annotate

Request

Request body

ratinginteger

Rating value for a single criterion (0-1 for THUMBS_RATING, 1-5 for FIVE_STAR_RATING). Shorthand for a one-entry annotations array.

type'THUMBS_RATING' | 'FIVE_STAR_RATING'

Type of the rating.

namestring

Criterion name. Omit for the default criterion; otherwise it must match a configured custom criterion (or a form criteria field), or the annotation will not appear.

expectedOutcomestring

Expected outcome (for thread items only).

expectedOutputstring

Expected output (for trace/span items only).

explanationstring

Explanation for the rating.

annotatorEmailstring email

Project member to attribute the work to. Required when submitting formResponses, otherwise they will not appear in the platform.

markAsCompletedboolean

Whether to mark the queue item as completed. For form queues, completing enforces the form's required fields.

Response

Successfully annotated the queue item

successboolean required

Indicates if the queue item was successfully annotated.

Changes

  • 877d6d6d5a76Revision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became optional for the status

    • warning

      deleted the header request parameter CONFIDENT_API_KEY

    • warning

      deleted the path request parameter itemId

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      the request property default value Default was removed

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status