Pauses

✨ Put pause

Changed on
<Card href="https://humansignal.com/goenterprise"> <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/> <p style="margin-top: 10px; font-size: 14px;"> This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) </p> </Card> Overwrite a pause entry by ID.
put/api/projects/{project_pk}/members/{user_pk}/pauses/{id}/

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/api/projects/{project_pk}/members/{user_pk}/pauses/{id}/
  • Auth
    API key in header Authorization

Path parameters

idinteger required

A unique integer value identifying this pause.

project_pkinteger required
user_pkinteger required

Request body

reason'MANUAL' | 'BEHAVIOR_BASED' | 'ANNOTATOR_EVALUATION' | 'ANNOTATION_LIMIT' | 'CUSTOM_SCRIPT' required
  • MANUAL - Manual
  • BEHAVIOR_BASED - Behavior-based
  • ANNOTATOR_EVALUATION - Annotator evaluation
  • ANNOTATION_LIMIT - Annotation limit
  • CUSTOM_SCRIPT - Custom script
verbose_reasonstring nullable

Detailed description of why the project is paused, will be readable by paused annotators

Response

created_atstring date-time required

Timestamp when this pause record was created

deleted_atstring date-time nullable required

Timestamp when this pause record was soft-deleted

deleted_byinteger nullable required

User who soft-deleted this pause record

idinteger required
projectinteger nullable required

Related project for which the pause is set

reason'MANUAL' | 'BEHAVIOR_BASED' | 'ANNOTATOR_EVALUATION' | 'ANNOTATION_LIMIT' | 'CUSTOM_SCRIPT' required
  • MANUAL - Manual
  • BEHAVIOR_BASED - Behavior-based
  • ANNOTATOR_EVALUATION - Annotator evaluation
  • ANNOTATION_LIMIT - Annotation limit
  • CUSTOM_SCRIPT - Custom script
updated_atstring date-time required

Timestamp when this pause record was last updated

userinteger nullable required

User who is paused

verbose_reasonstring nullable

Detailed description of why the project is paused, will be readable by paused annotators

Changes

  • b5f055b9d45bRevision changes
    • breaking

      the response property ///// became nullable for the status

  • c2893748a8d3Revision changes
    • breaking

      for the path request parameter id, the type changed from string to integer