Dimensions

✨ Update dimension

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> Update a specific dimension by ID.
patch/api/projects/{project_pk}/dimensions/{id}/

Request

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

Path parameters

idinteger required

Dimension ID

project_pkinteger required

Project ID

Request body

descriptionstring

Human-readable description of what this dimension represents

extraction_methodstring

Method used to extract values from annotation JSON

extraction_method_paramsunknown
is_activeboolean

Whether this dimension is used in agreement calculations.

is_user_definedboolean

Whether this dimension was manually created by a user. System-generated dimensions have this set to False.

metric_paramsunknown
metric_typestring

Strategy for comparing dimension values across annotators

namestring

Unique identifier for this dimension within the project

orderinteger

Display order within the project

Response

Updated dimension

allowed_metrics_with_paramsobject required

Dictionary mapping metric type names to their parameter schemas.

control_tagstring nullable required

Name of the control tag this dimension is extracted from. Set automatically for system dimensions.

created_atstring date-time required
created_byinteger nullable required

User who created this dimension

descriptionstring

Human-readable description of what this dimension represents

extraction_methodstring

Method used to extract values from annotation JSON

extraction_method_paramsunknown
idinteger required
is_activeboolean

Whether this dimension is used in agreement calculations.

is_categoricalboolean required

Whether this dimension produces categorical (primitive/scalar) values.

is_user_definedboolean

Whether this dimension was manually created by a user. System-generated dimensions have this set to False.

metric_paramsunknown
metric_typestring

Strategy for comparing dimension values across annotators

namestring required

Unique identifier for this dimension within the project

orderinteger

Display order within the project

projectinteger required

Project this dimension belongs to

updated_atstring date-time required
values_enumunknown required

Changes