Interface Agent

An Agent in a Workspace

interface Agent {
    uid: string;
    name: string;
    description: string;
    mode: string;
    icon: string;
    isPublished: boolean;
    publishedAt: number;
    createdAt: number;
    updatedAt: number;
}

Properties

uid: string

Agent UID, used as the path parameter of AgentContext.conversation

name: string

Agent name

description: string

Agent description

mode: string

Agent mode, e.g. chat

icon: string

Icon URL

isPublished: boolean

Whether published; only published Agents can start conversations

publishedAt: number

Publish time, Unix timestamp in seconds; 0 if unpublished

createdAt: number

Creation time, Unix timestamp in seconds

updatedAt: number

Last updated time, Unix timestamp in seconds