Create a label

async AsyncCogniteClient.labels.create(

label: LabelDefinition | LabelDefinitionWrite | Sequence[LabelDefinition | LabelDefinitionWrite],

) → LabelDefinition | LabelDefinitionList

Create one or more label definitions.

Deprecated since version 8.23.0: The Labels API is deprecated and is scheduled for removal on 2027-12-31. There is no direct replacement; model labels as a concept in your data model. See https://docs.cognite.com/cdf/deprecated for details and migration guidance.

Parameters:

label (LabelDefinition | LabelDefinitionWrite | Sequence[LabelDefinition | LabelDefinitionWrite]) – The label definition(s) to create.

Returns:

Created label definition(s)

Return type:

LabelDefinition | LabelDefinitionList

Raises:

TypeError – Function input ‘label’ is of the wrong type

Examples

Create new label definitions:

>>> from cognite.client import CogniteClient
>>> from cognite.client.data_classes import LabelDefinitionWrite
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>> labels = [
...     LabelDefinitionWrite(
...         external_id="ROTATING_EQUIPMENT", name="Rotating equipment"
...     ),
...     LabelDefinitionWrite(external_id="PUMP", name="pump"),
... ]
>>> res = client.labels.create(labels)