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"
}

PATCH /v2/annotation-configs/{annotation_config_id}

Update an annotation config

cURL

curl --request PATCH \
  --url https://api.arize.com/v2/annotation-configs/{annotation_config_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "annotation_config_type": "CATEGORICAL",
  "name": "quality-v2",
  "values": [
    {
      "label": "good",
      "score": 1
    },
    {
      "label": "bad",
      "score": 0
    }
  ],
  "optimization_direction": "MAXIMIZE"
}
'

200

{
  "id": "QW5ub3RhdGlvbkNvbmZpZzoxMjM0NQ==",
  "name": "quality-v2",
  "space_id": "space_12345",
  "type": "CATEGORICAL",
  "values": [
    {
      "label": "good",
      "score": 1
    },
    {
      "label": "bad",
      "score": 0
    }
  ],
  "optimization_direction": "MAXIMIZE",
  "created_at": "2024-01-01T00:00:00Z"
}

Authorizations

Authorization · string · header · required

Most Arize AI endpoints require authentication. For those endpoints that require authentication, include your API key in the request header using the format

Path Parameters

annotation_config_id · string · required

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

Example:

"RW50aXR5OjEyMzQ1"

Body

application/json

Body containing annotation config update parameters. The annotation_config_type is required and must match the stored config's type.

Option 1

Option 2

Option 3

annotation_config_type · enum<string> · required

The type of annotation config:

• CONTINUOUS: a numeric score within a defined range
• CATEGORICAL: a set of labeled values each with an optional score
• FREEFORM: free-text annotation with no structured scoring

Available options: CONTINUOUS

name · string

New name for the annotation config. Must be unique within the space.

minimum_score · number<double>

New minimum score value.

maximum_score · number<double>

New maximum score value.

optimization_direction · enum<string> · default: NONE

New optimization direction.

Available options: MAXIMIZE, MINIMIZE, NONE

Response

200

application/json

An annotation config object

Option 1

Option 2

Option 3

id · string · required

The unique identifier for the annotation config

name · string · required

The name of the annotation config

created_at · string<date-time> · required

The timestamp for when the annotation config was created

space_id · string · required

The space id the annotation config belongs to

type · enum<string> · required

Discriminator value identifying a continuous annotation config.

Available options: CONTINUOUS

minimum_score · number<double> · required

The minimum score value

maximum_score · number<double> · required

The maximum score value

optimization_direction · enum<string> · default: NONE

Direction for optimization. When absent, the server treats the value as NONE.

Available options: MAXIMIZE, MINIMIZE, NONE