Skip to content
Last updated

Represents an icon that can be used throughout the platform, including for assistants. Icons can be system-provided or custom-uploaded by organizations.

Properties

id string

Unique identifier for the icon (e.g., icon_abc123def456ghi789).

name string

Human-readable name of the icon.

description string

Optional description of the icon.

tags array

Array of tags for categorizing and searching the icon.

category string

Icon category. Common values: business, creative, technical, custom.

file_format string

File format of the icon. Values: svg, png, jpg.

is_system boolean

Whether this is a system-provided icon (true) or a custom organization icon (false).

url string

URL path to retrieve the icon file (e.g., /v1/icons/icon_abc123).

created_at string

Timestamp when the icon was created (ISO 8601 format).

updated_at string

Timestamp when the icon was last updated (ISO 8601 format).

{
  "id": "icon_sparkles123",
  "name": "Sparkles",
  "description": "Sparkles icon",
  "tags": ["creative", "sparkles"],
  "category": "creative",
  "file_format": "svg",
  "is_system": true,
  "is_active": true,
  "url": "/v1/icons/icon_sparkles123",
  "created_at": "2025-12-03T10:00:00Z",
  "updated_at": "2025-12-03T10:00:00Z"
}