Sign in
Dimensions

✨ Create dimension

<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> Create a new dimension for a specific project.
post/api/projects/{project_pk}/dimensions/

Path parameters

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

{"stackTrail":"components:schemas:DimensionCreateRequest:properties:extraction_method_params","oasType":"schema","type":"unknown","title":"Extraction method parameters","description":"Parameters specific to the extraction method. See metrics.py for available extraction methods and their parameters."}
is_activeboolean

Whether this dimension is used in agreement calculations.

{"stackTrail":"components:schemas:DimensionCreateRequest:properties:metric_params","oasType":"schema","type":"unknown","title":"Metric parameters","description":"Parameters for the metric. See metrics.py for available metrics and their parameters."}
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

Response

Created 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

{"stackTrail":"components:schemas:Dimension:properties:extraction_method_params","oasType":"schema","type":"unknown","title":"Extraction method parameters","description":"Parameters specific to the extraction method. See metrics.py for available extraction methods and their parameters."}
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.

{"stackTrail":"components:schemas:Dimension:properties:metric_params","oasType":"schema","type":"unknown","title":"Metric parameters","description":"Parameters for the metric. See metrics.py for available metrics and their parameters."}
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
{"stackTrail":"components:schemas:Dimension:properties:values_enum","oasType":"schema","type":"unknown","description":"Schema-defined enum values for indexed value_counts. Refreshed only with label config changes.","nullable":true}

Changes

Changed in 3 of the 97 revisions of this API.12

  • b5f055b9d45b1See the full diff
    • ▲

      the allowed_metrics_with_params response's property type/format changed from string/ to object/ for status 201

      response-property-type-changed

  • c2d3e4a78bf81See the full diff
    • ○

      added the required property values_enum to the response with the 201 status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 69cec012f2d31See the full diff
    • ○

      added the required property is_categorical to the response with the 201 status

      response-required-property-added

Of the 97 revisions, 1 has no diff computed.