API ReferenceComments

✨ Update comment

<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> Update a specific comment by ID.

Authentication

AuthorizationToken
The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>

Path parameters

idstringRequired

Query parameters

expand_created_bybooleanOptional

Expand the created_by field

Request

This endpoint expects an object.
annotationinteger or nullOptional
classificationsany or nullOptional
Classifications applied by a reviewer or annotator
draftinteger or nullOptional
is_resolvedbooleanOptional
True if the comment is resolved
region_refany or nullOptional
Set if this comment is related to a specific part of the annotation. Normally contains region ID and control name.
textstring or nullOptional
Reviewer or annotator comment

Response

Commentobject

Comment Serializer with FSM state support.

Note: The ‘state’ field will be populated from the queryset annotation if present, preventing N+1 queries. Use .with_state() on your queryset.

The state field display is controlled by both:

  • fflag_feat_fit_568_finite_state_management (FSM background calculations)
  • fflag_feat_fit_710_fsm_state_fields (state field display in APIs)
OR
CommentSerializerWithExpandedUserobject

Comment Serializer with FSM state support.

Note: The ‘state’ field will be populated from the queryset annotation if present, preventing N+1 queries. Use .with_state() on your queryset.

The state field display is controlled by both:

  • fflag_feat_fit_568_finite_state_management (FSM background calculations)
  • fflag_feat_fit_710_fsm_state_fields (state field display in APIs)