Interface PlanInterface

Base entity interface for all platform resources

All entities in the Mosaia platform extend this interface to provide consistent base properties across all resource types. This ensures that all entities have common fields for identification, status, and integration capabilities.

Example

const entity: BaseEntity = {
  id: 'entity-123',
  active: true,
  external_id: 'external-system-id',
  extensors: {
    custom_field: 'custom_value'
  }
};
interface PlanInterface {
    record_history?: RecordHistory;
    id?: string;
    task?: string;
    agent?: string | { id?: string; [key: string]: any };
    log?: string | { id?: string; [key: string]: any };
    parent_log?: string | { id?: string; [key: string]: any };
    org?: string | { id?: string; [key: string]: any };
    user?: string | { id?: string; [key: string]: any };
    name?: string;
    description?: string;
    content?: string;
    status?: PlanStatus;
    active?: boolean;
    keywords?: string[];
    tags?: string[];
    external_id?: string;
    extensors?: Record<string, any>;
    tasks?: any;
}

Hierarchy (View Summary)

Properties

record_history? id? task? agent? log? parent_log? org? user? name? description? content? status? active? keywords? tags? external_id? extensors? tasks?

Properties

Optionalrecord_history

record_history?: RecordHistory

Record history tracking information

Optionalid

id?: string

Unique identifier for the entity

Optionaltask

task?: string

Optionalagent

agent?: string | { id?: string; [key: string]: any }

Agent reference (optional)

Optionallog

log?: string | { id?: string; [key: string]: any }

Agent log reference for execution tracking (optional)

Optionalparent_log

parent_log?: string | { id?: string; [key: string]: any }

AgentLog reference when this plan was created (optional)

Optionalorg

org?: string | { id?: string; [key: string]: any }

Organization reference (optional)

Optionaluser

user?: string | { id?: string; [key: string]: any }

User reference (optional)

Optionalname

name?: string

Optionaldescription

description?: string

High-level 1–2 sentence summary of what this plan will accomplish

Optionalcontent

content?: string

Markdown content defining the plan (required on create)

Optionalstatus

status?: PlanStatus

Optionalactive

active?: boolean

Whether the entity is active

Optionalkeywords

keywords?: string[]

Optionaltags

tags?: string[]

Optionalexternal_id

external_id?: string

External system identifier for integration with third-party systems

Optionalextensors

extensors?: Record<string, any>

Extended properties for custom integrations

Optional Readonlytasks

tasks?: any

Settings

Member Visibility

On This Page

Properties