annotation-queues

Get Annotation Queues

Changed on
get/api/v1/annotation-queues

Request

  • Base URL
    https://api.smith.langchain.com
  • URL
    https://api.smith.langchain.com/api/v1/annotation-queues
  • Auth
    • API key in header X-API-Key
    • or API key in header X-Tenant-Id
    • or HTTP bearer

Query parameters

idsstring[] nullable
namestring nullable
name_containsstring nullable
offsetinteger
limitinteger
tag_value_idstring[] nullable
dataset_idstring uuid nullable
queue_type'single' | 'pairwise' nullable
assigned_to_meboolean
sort_bystring nullable
sort_by_descboolean

Response

Successful Response

descriptionstring nullable
created_atstring date-time
updated_atstring date-time
num_reviewers_per_iteminteger nullable
enable_reservationsboolean nullable
reservation_minutesinteger nullable
reviewer_access_modestring
namestring required
idstring uuid required
tenant_idstring uuid required
source_rule_idstring uuid nullable
run_rule_idstring uuid nullable
default_datasetstring uuid nullable
queue_type'single' | 'pairwise' required
metadataobject nullable
total_runsinteger required

Changes

  • 1a8ee9358d81Revision changes
    • breaking

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

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

  • 99490d1e837eRevision changes
    • info

      added the new optional query request parameter sort_by

    • info

      added the new optional query request parameter sort_by_desc