Sign in

v3

latestOpenAPI 3.1.02026-07-311,4541,5202.3 MB
evaluations

Api Annotation Items Retrieve

GET/PATCH/DELETE /api/annotation-items/{id}/

Retrieve, update, or delete a specific annotation item (RUD from CRUD).

Permission (via ObjectOwnershipMixin config in SuperAdminMixin):

  • Worker (assignee): Can GET/PATCH their OWN assigned items (status only)
  • Org Admin: Can GET/PATCH/DELETE any item in org (can re-assign)
  • Superadmin: Can access all items across all orgs

GET: Returns full item details with all fields PATCH:

  • Worker: Update status, completed_at
  • Admin: Also update assignee_id (re-assign) DELETE: Delete item (admin only via ownership check)
get/api/annotation-items/{id}/

Path parameters

idstring required

Headers

Authorizationstring required

JWT access token or Respan API key

Response

idstring required
projectstring nullable
source_idstring required
source_type'logs' | 'dataset_logs' | 'threads' required
  • logs - Logs
  • dataset_logs - Dataset Logs
  • threads - Threads
source_dataset_idstring nullable required
evaluator_idsstring[] required

List of evaluator IDs that define which scoring criteria the assignee should fill out

status'pending' | 'processing' | 'paused' | 'completed' | 'failed' | 'cancelled'
  • pending - Pending
  • processing - Processing
  • paused - Paused
  • completed - Completed
  • failed - Failed
  • cancelled - Cancelled
{"stackTrail":"components:schemas:AnnotationItemDetail:properties:full_object","oasType":"schema","type":"unknown","description":"Any type"}
created_atstring date-time required
completed_atstring date-time nullable
updated_atstring date-time required
organizationinteger required