> ## Documentation Index
> Fetch the complete documentation index at: https://arize-ax.mintlify.site/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# 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)
```json
{
"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`)
```json
{
"name": "quality-v2"
}
```
This endpoint is in beta, read more [here](https://arize.com/docs/ax/rest-reference#api-version-stages).
## OpenAPI
````yaml https://api.arize.com/v2/spec.yaml patch /v2/annotation-configs/{annotation_config_id}
openapi: 3.0.3
info:
title: Arize REST API
version: 2.0.0
description: |
API specification for the backend data server. The API is hosted globally
at https://api.arize.com/v2 or in your own environment.
license:
name: Apache-2.0
url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- description: Global
url: https://api.arize.com
- description: Regional
url: https://api.{region}.arize.com
variables:
region:
default: eu-west-1a
enum:
- eu-west-1a
- ca-central-1a
- description: Custom Host
url: https://{host}
variables:
host:
default: api.arize.com
security:
- bearerAuth: []
tags:
- name: AI Integrations
description: |
AI integrations configure access to external LLM providers (e.g. OpenAI,
Azure OpenAI, AWS Bedrock, Vertex AI). Integrations can be scoped to the
entire account, a specific organization, or a specific space.
- name: Annotation Configs
description: >
Annotation configs allow you to define consistent annotation schemas that
can be reused across your workspace, ensuring evaluations are structured
and
comparable over time.
- name: Annotation Queues
description: >
Annotation queues help you organize and manage human evaluation workflows.
Use queues to assign spans or examples to annotators for review and
labeling.
- name: API Keys
description: >
API keys are used to authenticate requests to the Arize API. List your
keys
to view metadata; the raw secret is never returned after creation.
- name: Datasets
description: |
Datasets are structured, version-controlled example collections you use to
run, evaluate, and track LLM experiments.
- name: Evaluators
description: >
Evaluators are reusable evaluation configurations used to assess the
quality
of LLM outputs. They can be template-based (using LLM judges) or
code-based.
- name: Experiments
description: >
Experiments let you systematically test prompt/model changes using
datasets,
tasks, and evaluators.
- name: Integrations
description: >
Integrations configure access to external LLM providers (e.g. OpenAI,
Azure OpenAI, AWS Bedrock, Vertex AI), notifications services (e.g.
PagerDuty, Slack), and
your own agents. Integrations can be scoped to the entire account, a
specific
organization, or a specific space.
- name: Organizations
description: >
Organizations are top-level containers within an Arize AX account for
grouping spaces.
- name: Projects
description: |
Projects represent LLM applications being monitored in Arize where you can
observe traces and spans.
- name: Prompts
description: >
Prompts are reusable, versioned templates for LLM interactions. Use
prompts
to standardize and manage how you interact with LLMs across your
application.
- name: Resource Restrictions
description: |
Endpoints for restricting and unrestricting resources (projects, models).
- name: Role Bindings
description: |
Role bindings assign a role to a user on a resource. REST currently
supports space- and project-scoped bindings.
- name: Roles
description: >
Roles define sets of permissions that can be assigned to users within an
account. Create custom roles to tailor access control to your team's
needs.
- name: Spaces
description: >
Spaces are containers within an organization for grouping related
projects,
datasets, and experiments, enabling collaboration or isolated
experimentation
with role-based access control.
- name: Spans
description: |
Spans represent individual operations within a trace. A span captures the
timing, status, and attributes of a single operation in your application.
- name: Tasks
description: |
Tasks are configurable units of work that tie one or more evaluators to a
data source (project or dataset). Use tasks to automate evaluation of LLM
outputs, with support for continuous evaluation and backfill runs.
- name: Users
description: >
Users represent members of an account. The Users endpoints allow creating,
listing, updating (display name), and removing users from the account
programmatically.
paths:
/v2/annotation-configs/{annotation_config_id}:
patch:
tags:
- Annotation Configs
summary: Update an annotation config
description: >
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)
```json
{
"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`)
```json
{
"name": "quality-v2"
}
```
This endpoint is in beta, read more
[here](https://arize.com/docs/ax/rest-reference#api-version-stages).
operationId: annotation_configs_update
parameters:
- $ref: '#/components/parameters/AnnotationConfigIdPathParam'
requestBody:
$ref: '#/components/requestBodies/UpdateAnnotationConfigRequestBody'
responses:
'200':
$ref: '#/components/responses/AnnotationConfig'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'409':
$ref: '#/components/responses/Conflict'
'422':
$ref: '#/components/responses/UnprocessableEntity'
'429':
$ref: '#/components/responses/RateLimitExceeded'
components:
parameters:
AnnotationConfigIdPathParam:
name: annotation_config_id
in: path
description: The unique annotation config identifier (base64)
required: true
schema:
$ref: '#/components/schemas/Id'
example: QW5ub3RhdGlvbkNvbmZpZzoxMjM0NQ==
requestBodies:
UpdateAnnotationConfigRequestBody:
description: >-
Body containing annotation config update parameters. The
annotation_config_type is required and must match the stored config's
type.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateAnnotationConfigRequestBody'
example:
annotation_config_type: categorical
name: quality-v2
values:
- label: good
score: 1
- label: bad
score: 0
optimization_direction: maximize
responses:
AnnotationConfig:
description: An annotation config object
content:
application/json:
schema:
$ref: '#/components/schemas/AnnotationConfig'
example:
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'
BadRequest:
description: Invalid request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
example:
status: 400
title: Invalid request parameters
detail: The 'name' field is required and must be a non-empty string.
instance: /resource
type: https://arize.com/docs/ax/rest-reference/errors#invalid-request
Unauthorized:
description: Authentication is required
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
example:
status: 401
title: Authentication required
detail: You must be authenticated to access this resource.
instance: /resource
type: >-
https://arize.com/docs/ax/rest-reference/errors#authentication-required
Forbidden:
description: Insufficient permissions to access this resource
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
example:
status: 403
title: Access forbidden
detail: You do not have permission to access this resource.
instance: /resource/12345
type: https://arize.com/docs/ax/rest-reference/errors#access-forbidden
NotFound:
description: Not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
example:
status: 404
title: Resource not found
detail: The requested resource with ID '12345' was not found.
instance: /resource/12345
type: https://arize.com/docs/ax/rest-reference/errors#resource-not-found
Conflict:
description: Resource conflict
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
example:
status: 409
title: Resource conflict
detail: A resource with the given identifier already exists.
instance: /resource
type: https://arize.com/docs/ax/rest-reference/errors#resource-conflict
UnprocessableEntity:
description: Unprocessable entity
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
example:
status: 422
title: Unprocessable Entity
detail: Minimum score must be less than maximum score.
instance: /annotation-configs
type: >-
https://arize.com/docs/ax/rest-reference/errors#unprocessable-entity
RateLimitExceeded:
description: Rate limit exceeded
headers:
Retry-After:
description: |
When throttled (429), how long to wait before retrying. Value is
either a delta-seconds integer.
schema:
type: integer
minimum: 0
example: 42
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
example:
status: 429
title: Rate limit exceeded
detail: >-
You have exceeded the allowed number of requests. Please try again
later.
instance: /resource
type: >-
https://arize.com/docs/ax/rest-reference/errors#rate-limit-exceeded
schemas:
Id:
type: string
description: A universally unique identifier (base64-encoded opaque string).
example: RW50aXR5OjEyMzQ1
UpdateAnnotationConfigRequestBody:
required:
- annotation_config_type
properties:
annotation_config_type:
$ref: '#/components/schemas/AnnotationConfigType'
discriminator:
propertyName: annotation_config_type
mapping:
continuous:
$ref: '#/components/schemas/ContinuousAnnotationConfigUpdate'
categorical:
$ref: '#/components/schemas/CategoricalAnnotationConfigUpdate'
freeform:
$ref: '#/components/schemas/FreeformAnnotationConfigUpdate'
oneOf:
- $ref: '#/components/schemas/ContinuousAnnotationConfigUpdate'
- $ref: '#/components/schemas/CategoricalAnnotationConfigUpdate'
- $ref: '#/components/schemas/FreeformAnnotationConfigUpdate'
AnnotationConfig:
type: object
additionalProperties: true
discriminator:
propertyName: type
mapping:
continuous:
$ref: '#/components/schemas/ContinuousAnnotationConfig'
categorical:
$ref: '#/components/schemas/CategoricalAnnotationConfig'
freeform:
$ref: '#/components/schemas/FreeformAnnotationConfig'
oneOf:
- $ref: '#/components/schemas/ContinuousAnnotationConfig'
- $ref: '#/components/schemas/CategoricalAnnotationConfig'
- $ref: '#/components/schemas/FreeformAnnotationConfig'
Problem:
type: object
description: RFC 9457 Problem Details
properties:
title:
type: string
description: A short, human-readable summary of the problem type
status:
type: integer
description: >-
The HTTP status code generated by the origin server for this
occurrence of the problem
type:
type: string
format: uri-reference
description: A URI reference that identifies the problem type
detail:
type: string
description: >-
A human-readable explanation specific to this occurrence of the
problem
instance:
type: string
format: uri-reference
description: >-
A URI reference that identifies the specific occurrence of the
problem
required:
- title
- status
additionalProperties: false
AnnotationConfigType:
type: string
enum:
- continuous
- categorical
- freeform
description: |
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
ContinuousAnnotationConfigUpdate:
allOf:
- $ref: '#/components/schemas/AnnotationConfigUpdateBase'
- type: object
required:
- annotation_config_type
properties:
annotation_config_type:
type: string
enum:
- continuous
description: >
Discriminator value identifying a continuous annotation config.
The config
`type` is immutable and must match the stored config's type.
minimum_score:
type: number
format: double
description: New minimum score value.
maximum_score:
type: number
format: double
description: New maximum score value.
optimization_direction:
allOf:
- $ref: '#/components/schemas/OptimizationDirection'
description: New optimization direction.
CategoricalAnnotationConfigUpdate:
allOf:
- $ref: '#/components/schemas/AnnotationConfigUpdateBase'
- type: object
required:
- annotation_config_type
properties:
annotation_config_type:
type: string
enum:
- categorical
description: >
Discriminator value identifying a categorical annotation config.
The config
`type` is immutable and must match the stored config's type.
values:
type: array
description: >
The full replacement set of categorical annotation values (2–100
items).
items:
$ref: '#/components/schemas/CategoricalAnnotationValue'
optimization_direction:
allOf:
- $ref: '#/components/schemas/OptimizationDirection'
description: New optimization direction.
FreeformAnnotationConfigUpdate:
allOf:
- $ref: '#/components/schemas/AnnotationConfigUpdateBase'
- type: object
required:
- annotation_config_type
properties:
annotation_config_type:
type: string
enum:
- freeform
description: >
Discriminator value identifying a freeform annotation config.
The config
`type` is immutable and must match the stored config's type.
ContinuousAnnotationConfig:
allOf:
- $ref: '#/components/schemas/AnnotationConfigBase'
- type: object
required:
- type
- minimum_score
- maximum_score
properties:
type:
type: string
enum:
- continuous
description: Discriminator value identifying a continuous annotation config.
minimum_score:
type: number
format: double
description: The minimum score value
maximum_score:
type: number
format: double
description: The maximum score value
optimization_direction:
allOf:
- $ref: '#/components/schemas/OptimizationDirection'
description: >-
Direction for optimization. When absent, the server treats the
value as `none`.
CategoricalAnnotationConfig:
allOf:
- $ref: '#/components/schemas/AnnotationConfigBase'
- type: object
required:
- type
- values
properties:
type:
type: string
enum:
- categorical
description: Discriminator value identifying a categorical annotation config.
values:
type: array
description: An array of categorical annotation values
items:
$ref: '#/components/schemas/CategoricalAnnotationValue'
optimization_direction:
allOf:
- $ref: '#/components/schemas/OptimizationDirection'
description: >-
Direction for optimization. When absent, the server treats the
value as `none`.
FreeformAnnotationConfig:
allOf:
- $ref: '#/components/schemas/AnnotationConfigBase'
- type: object
required:
- type
properties:
type:
type: string
enum:
- freeform
description: Discriminator value identifying a freeform annotation config.
AnnotationConfigUpdateBase:
type: object
description: The base annotation config update parameters
properties:
name:
type: string
description: New name for the annotation config. Must be unique within the space.
OptimizationDirection:
type: string
enum:
- maximize
- minimize
- none
default: none
description: |
The direction for optimization. Defaults to `none` when omitted.
- maximize: higher scores are better
- minimize: lower scores are better
- none: higher or lower scores are neither better nor worse
CategoricalAnnotationValue:
type: object
required:
- label
properties:
label:
type: string
description: The label value
score:
type: number
format: double
description: A score to associate with the label
additionalProperties: false
AnnotationConfigBase:
type: object
required:
- id
- name
- created_at
- space_id
properties:
id:
type: string
description: The unique identifier for the annotation config
name:
type: string
description: The name of the annotation config
created_at:
type: string
description: The timestamp for when the annotation config was created
format: date-time
space_id:
type: string
description: The space id the annotation config belongs to
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat:
description: >
Most Arize AI endpoints require authentication. For those endpoints that
require authentication, include your API key in the request header using
the format
``` Authorization: Bearer
```
````