AgentFlowConfig

Defined in: types.ts:151

Configuration for AgentFlow.

Example

const builder = createGraphBuilder({
  agentId: 'portfolio-recon',
  trigger: 'user-request',
});

Properties

adapters?

readonly optional adapters?: readonly Adapter[]

Defined in: types.ts:161

Framework adapters to install.

---

agentId?

readonly optional agentId?: string

Defined in: types.ts:153

Identifier for the agent whose execution is being traced.

---

idGenerator?

readonly optional idGenerator?: () => string

Defined in: types.ts:163

Override the default counter-based ID generator.

Returns

string

---

logger?

readonly optional logger?: (message) => void

Defined in: types.ts:171

Custom logger (defaults to console.warn).

Parameters

Parameter	Type
message	string

Returns

void

---

name?

readonly optional name?: string

Defined in: types.ts:157

Display name for the execution graph.

---

onError?

readonly optional onError?: (error) => void

Defined in: types.ts:173

Error callback for internal failures.

Parameters

Parameter	Type
error	unknown

Returns

void

---

operatorContext?

readonly optional operatorContext?: OperatorContext

Defined in: types.ts:179

Operator context for organizational tracking.

---

parentSpanId?

readonly optional parentSpanId?: string

Defined in: types.ts:177

Parent span ID for linking to an upstream graph.

---

sessionHooks?

readonly optional sessionHooks?: { onSessionEnd?: (context) => void | Promise<void>; onSessionInitialized?: (context) => void | Promise<void>; onSessionStart?: (context) => Promise<{ briefing?: string; shouldProceed: boolean; warnings?: string[]; }> | { briefing?: string; shouldProceed: boolean; warnings?: string[]; }; }

Defined in: types.ts:181

Session initialization hooks for organizational context.

onSessionEnd?

readonly optional onSessionEnd?: (context) => void | Promise<void>

Called when session ends (graph build completes).

Parameters

Parameter	Type
context	{ briefing?: unknown; duration: number; graphId: string; operatorId?: string; organizationalContext?: { briefingAvailable: boolean; briefingSummary?: string; insightCount: number; teamContext?: unknown; }; sessionId?: string; status: "completed" | "failed" | "timeout"; teamId?: string; }
context.briefing?	unknown
context.duration	number
context.graphId	string
context.operatorId?	string
context.organizationalContext?	{ briefingAvailable: boolean; briefingSummary?: string; insightCount: number; teamContext?: unknown; }
context.organizationalContext.briefingAvailable	boolean
context.organizationalContext.briefingSummary?	string
context.organizationalContext.insightCount	number
context.organizationalContext.teamContext?	unknown
context.sessionId?	string
context.status	"completed" | "failed" | "timeout"
context.teamId?	string

Returns

void | Promise<void>

onSessionInitialized?

readonly optional onSessionInitialized?: (context) => void | Promise<void>

Called after graph construction but before execution.

Parameters

Parameter	Type
context	{ briefing?: unknown; graphId: string; operatorId?: string; organizationalContext?: { briefingAvailable: boolean; briefingSummary?: string; insightCount: number; relatedSessions: readonly unknown[]; teamContext?: unknown; }; sessionId?: string; teamId?: string; traceId: string; }
context.briefing?	unknown
context.graphId	string
context.operatorId?	string
context.organizationalContext?	{ briefingAvailable: boolean; briefingSummary?: string; insightCount: number; relatedSessions: readonly unknown[]; teamContext?: unknown; }
context.organizationalContext.briefingAvailable	boolean
context.organizationalContext.briefingSummary?	string
context.organizationalContext.insightCount	number
context.organizationalContext.relatedSessions	readonly unknown[]
context.organizationalContext.teamContext?	unknown
context.sessionId?	string
context.teamId?	string
context.traceId	string

Returns

void | Promise<void>

onSessionStart?

readonly optional onSessionStart?: (context) => Promise<{ briefing?: string; shouldProceed: boolean; warnings?: string[]; }> | { briefing?: string; shouldProceed: boolean; warnings?: string[]; }

Called before graph construction starts.

Parameters

Parameter	Type
context	{ agentId?: string; briefing?: string; insights?: readonly unknown[]; operatorId?: string; recommendations?: readonly string[]; sessionId?: string; teamId?: string; trigger?: string; warnings?: readonly string[]; }
context.agentId?	string
context.briefing?	string
context.insights?	readonly unknown[]
context.operatorId?	string
context.recommendations?	readonly string[]
context.sessionId?	string
context.teamId?	string
context.trigger?	string
context.warnings?	readonly string[]

Returns

Promise<{ briefing?: string; shouldProceed: boolean; warnings?: string[]; }> | { briefing?: string; shouldProceed: boolean; warnings?: string[]; }

---

timeout?

readonly optional timeout?: { agent?: number; default?: number; tool?: number; }

Defined in: types.ts:165

Timeout configuration in milliseconds.

agent?

readonly optional agent?: number

default?

readonly optional default?: number

tool?

readonly optional tool?: number

---

traceId?

readonly optional traceId?: string

Defined in: types.ts:175

Distributed trace ID to join an existing trace.

---

trigger?

readonly optional trigger?: string

Defined in: types.ts:155

What initiated this execution (e.g. "user-request", "cron-job").

---

writer?

readonly optional writer?: Writer

Defined in: types.ts:159

Output writer for completed graphs.