Skip to main content
PATCH
Update a tag

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

tag_id
string
required

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

Example:

"RW50aXR5OjEyMzQ1"

Body

application/json

Body containing the tag fields to update. At least one of name, description, or color must be provided.

Fields to update on a tag. Omitted fields are left unchanged, so at least one field must be provided.

name
string

New tag name. Must be unique within the space, compared case-insensitively. Maximum 100 characters. Left unchanged when omitted.

Required string length: 1 - 100
description
string | null

New description. Pass null to clear it. Left unchanged when omitted.

color
enum<string> | null

New display color. Pass null to clear it. Left unchanged when omitted.

Available options:
GRAY,
INDIGO,
BLUE,
CYAN,
TEAL,
PINE,
GREEN,
LIME,
OLIVE,
LEMON,
YELLOW,
ORANGE,
RED,
CORAL,
PINK,
PLUM,
PURPLE,
BROWN,
AUBURN

Response

A tag object

A tag is a reusable label defined once per space and attached to many resources across the platform, so the same vocabulary can be applied to projects, datasets, prompts, and more.

Tags are shared. Renaming a tag changes it everywhere it appears, and deleting a tag detaches it from every resource it was attached to.

id
string
required

The unique identifier of the tag

Example:

"RW50aXR5OjEyMzQ1"

name
string
required

The tag name. Unique within the space, compared case-insensitively.

space_id
string
required

The unique identifier of the space the tag belongs to

Example:

"RW50aXR5OjEyMzQ1"

created_at
string<date-time>
required

When the tag was created

updated_at
string<date-time>
required

When the tag was last modified. Equal to created_at until the tag is updated.

description
string | null

Free-form description of what the tag is for. null when no description has been set.

color
enum<string> | null

Display color for the tag. null when no color has been assigned, which clients render with a neutral treatment.

Available options:
GRAY,
INDIGO,
BLUE,
CYAN,
TEAL,
PINE,
GREEN,
LIME,
OLIVE,
LEMON,
YELLOW,
ORANGE,
RED,
CORAL,
PINK,
PLUM,
PURPLE,
BROWN,
AUBURN