Skip to main content
POST
Create an annotation config

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

Body

application/json

Body containing annotation config creation parameters

name
string
required

Name of the new annotation config

space_id
string
required

ID of the space the annotation config will belong to

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
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. Defaults to NONE when omitted.

Available options:
MAXIMIZE,
MINIMIZE,
NONE

Response

An annotation config object

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