annotation-queues

Get Annotation Queue

Changed on
get/api/v1/annotation-queues/{queue_id}

Request

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

Path parameters

queue_idstring uuid required

ID of the annotation queue.

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
rubric_instructionsstring nullable

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

    • info

      added the optional property /// to the 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

      added the optional property to the 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