Interface AgentInterface

Agent entity interface

Mirrors macs-node-sdk/lib/ai/models/agent.js. Required on create: name, description. model is an array of Model ObjectIds in priority order.

interface AgentInterface {
    external_id?: string;
    extensors?: { [key: string]: string };
    record_history?: RecordHistory;
    id?: string;
    org?: string;
    user?: string;
    name: string;
    description: string;
    readme?: string;
    image?: string;
    model?: string[];
    system_message?: string;
    max_tokens?: number;
    temperature?: number;
    public?: boolean;
    mia?: boolean;
    forked?: AgentForkedRef;
    featured?: boolean;
    active?: boolean;
    tags?: string[];
    keywords?: string[];
    chat?: any;
    tasks?: any;
    logs?: any;
}

Hierarchy (View Summary)

Properties

external_id? extensors? record_history? id? org? user? name description readme? image? model? system_message? max_tokens? temperature? public? mia? forked? featured? active? tags? keywords? chat? tasks? logs?

Properties

Optionalexternal_id

external_id?: string

External system identifier for integration with third-party systems

Optionalextensors

extensors?: { [key: string]: string }

Extended properties for custom integrations

Optionalrecord_history

record_history?: RecordHistory

Record history tracking information

Optionalid

id?: string

Unique identifier for the entity

Optionalorg

org?: string

Optionaluser

user?: string

name

name: string

Agent name (required, regex [a-zA-Z0-9_-]+)

description

description: string

One-line description (required)

Optionalreadme

readme?: string

Markdown README shown on the agent profile

Optionalimage

image?: string

Optionalmodel

model?: string[]

Models in priority order. Defaults to [DEFAULT_LLM_MODEL] when omitted.

Optionalsystem_message

system_message?: string

System message injected at the top of every completion

Optionalmax_tokens

max_tokens?: number

Max output tokens

Optionaltemperature

temperature?: number

Sampling temperature (0–2, default 0)

Optionalpublic

public?: boolean

Public listing flag

Optionalmia

mia?: boolean

Built-in "Mia" assistant flag — set server-side, never by clients

Optionalforked

forked?: AgentForkedRef

Origin agent if this one was forked

Optionalfeatured

featured?: boolean

Featured listing flag

Optionalactive

active?: boolean

Whether the entity is active

Optionaltags

tags?: string[]

Optionalkeywords

keywords?: string[]

Optional Readonlychat

chat?: any

Optional Readonlytasks

tasks?: any

Optional Readonlylogs

logs?: any

Settings

Member Visibility

On This Page

Properties