v76

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-015764591.5 MB

Comments

✨ Put 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> Overwrite a specific comment by ID.

put/api/comments/{id}/

Path parameters

idinteger required

A unique integer value identifying this comment.

Query parameters

expand_created_byboolean

Expand the created_by field

Request body

annotationinteger nullable

{"stackTrail":"components:schemas:CommentRequest:properties:classifications","oasType":"schema","type":"unknown","description":"Classifications applied by a reviewer or annotator","nullable":true}

draftinteger nullable

is_resolvedboolean

True if the comment is resolved

{"stackTrail":"components:schemas:CommentRequest:properties:region_ref","oasType":"schema","type":"unknown","description":"Set if this comment is related to a specific part of the annotation. Normally contains region ID and control name.","nullable":true}

textstring nullable

Reviewer or annotator comment

Response

annotationinteger nullable

{"stackTrail":"components:schemas:Comment:properties:classifications","oasType":"schema","type":"unknown","description":"Classifications applied by a reviewer or annotator","nullable":true}

created_atstring date-time required

Creation time

created_byinteger required

User who made this comment

draftinteger nullable

idinteger required

is_resolvedboolean

True if the comment is resolved

projectinteger nullable required

{"stackTrail":"components:schemas:Comment:properties:region_ref","oasType":"schema","type":"unknown","description":"Set if this comment is related to a specific part of the annotation. Normally contains region ID and control name.","nullable":true}

resolved_atstring date-time nullable required

Resolving time

statestring required

taskinteger nullable required

textstring nullable

Reviewer or annotator comment

updated_atstring date-time required

Last updated time