Interface Workflow

Workflow definition

Defines a multi-step process that orchestrates agents, tools, and other operations.

Example

const workflow: Workflow = {
  id: 'customer-onboarding',
  name: 'Customer Onboarding',
  version: '1.0.0',
  steps: [
    {
      type: 'agent',
      id: 'step-1',
      agentId: 'welcome-agent',
      input: { type: 'variable', name: 'customerData' },
      output: 'welcomeMessage'
    },
    {
      type: 'tool',
      id: 'step-2',
      toolName: 'sendEmail',
      input: { type: 'variable', name: 'welcomeMessage' }
    }
  ],
  timeout: 300000
};
interface Workflow {
    id: string;
    name: string;
    version: string;
    steps: WorkflowStep[];
    triggers?: WorkflowTrigger[];
    timeout?: number;
    metadata?: Record<string, unknown>;
}

Properties

id name version steps triggers? timeout? metadata?

Properties

Readonlyid

id: string

Unique identifier

Readonlyname

name: string

Human-readable name

Readonlyversion

version: string

Semantic version

Readonlysteps

steps: WorkflowStep[]

Workflow steps

Optional Readonlytriggers

triggers?: WorkflowTrigger[]

Trigger configuration

Optional Readonlytimeout

timeout?: number

Overall timeout in milliseconds

Optional Readonlymetadata

metadata?: Record<string, unknown>

Additional metadata

Settings

Member Visibility

On This Page

Properties