Update a tag
Update a tag’s name, description, or color.
Tags are shared, so an update is visible on every resource the tag is attached to.
Payload Requirements
- At least one of
name,description, orcolormust be provided. Omitted fields are left unchanged. name, when provided, must be non-empty after trimming, at most 100 characters, and unique within the space compared case-insensitively. A collision returns409.descriptionandcoloracceptnullto clear the current value.- System-managed fields (
id,created_at,updated_at) cannot be modified.updated_atis advanced automatically.
Valid example
{
"name": "production-critical",
"color": "RED"
}
Invalid example (empty body — nothing to update)
Request:
{}
Response:
{
"type": "https://arize.com/docs/ax/rest-reference/errors#invalid-request",
"title": "Bad Request",
"status": 400,
"detail": "At least one field (name, description, color) must be provided",
"request_id": "req_01HZY6X8E7"
}
Unrecognized fields are rejected with 400 rather than ignored, so a
misspelled field name fails loudly instead of silently doing nothing.
Authorizations
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
The unique tag identifier (base64) A universally unique identifier (base64-encoded opaque string).
"RW50aXR5OjEyMzQ1"
Body
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.
New tag name. Must be unique within the space, compared case-insensitively. Maximum 100 characters. Left unchanged when omitted.
1 - 100New description. Pass null to clear it. Left unchanged when omitted.
New display color. Pass null to clear it. Left unchanged when omitted.
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.
The unique identifier of the tag
"RW50aXR5OjEyMzQ1"
The tag name. Unique within the space, compared case-insensitively.
The unique identifier of the space the tag belongs to
"RW50aXR5OjEyMzQ1"
When the tag was created
When the tag was last modified. Equal to created_at until the tag is
updated.
Free-form description of what the tag is for. null when no description
has been set.
Display color for the tag. null when no color has been assigned, which
clients render with a neutral treatment.
GRAY, INDIGO, BLUE, CYAN, TEAL, PINE, GREEN, LIME, OLIVE, LEMON, YELLOW, ORANGE, RED, CORAL, PINK, PLUM, PURPLE, BROWN, AUBURN