v2

latestOpenAPI 3.0.3Apache-2.02026-08-07119359591.9 KB
Annotation Configs

Update an annotation config

Update an annotation config by its ID.

Payload Requirements

  • annotation_config_type is required and must match the stored config's type. The type is immutable and cannot be changed.
  • The updatable fields depend on the type:
    • CATEGORICAL: name, values, optimization_direction.
    • CONTINUOUS: name, minimum_score, maximum_score, optimization_direction.
    • FREEFORM: name.
  • All fields other than annotation_config_type are optional; omitted fields are left unchanged.
  • name, if provided, must be unique within the space (409 Conflict if duplicate).
  • values replaces the full label set (2-100 labels).
  • System-managed fields (id, space_id, created_at) cannot be modified.

Valid example (categorical config)

{
  "annotation_config_type": "CATEGORICAL",
  "name": "quality-v2",
  "values": [
    { "label": "good", "score": 1 },
    { "label": "bad", "score": 0 }
  ],
  "optimization_direction": "MAXIMIZE"
}

Invalid example (missing annotation_config_type)

{
  "name": "quality-v2"
}

<Note>This endpoint is in beta, read more here.</Note>

patch/v2/annotation-configs/{annotation_config_id}

Path parameters

annotation_config_idstring required

A universally unique identifier (base64-encoded opaque string).

Example:RW50aXR5OjEyMzQ1

The unique annotation config identifier (base64)

Request body

OR
OR

Response

An annotation config object

OR
OR