PersistentAI API Documentation / @persistentai/fireflow-types / IBranchParams

Interface: IBranchParams

Defined in: packages/fireflow-types/src/execution/services/dbos-types.ts:172

Parameters for executing a parallel branch as a separate DBOS workflow. Each branch gets its own function_id counter space, solving the non-deterministic replay issue with parallel branches.

Properties

branchId

branchId: string

Defined in: packages/fireflow-types/src/execution/services/dbos-types.ts:180

Unique branch identifier (e.g., "dbos-branch-0-NodeA")

---

executionDepth

executionDepth: number

Defined in: packages/fireflow-types/src/execution/services/dbos-types.ts:182

Execution nesting depth

---

flowId

flowId: string

Defined in: packages/fireflow-types/src/execution/services/dbos-types.ts:174

Flow ID (same flow as parent — branch executes a subset of nodes)

---

integrations?

optional integrations: Record<string, unknown>

Defined in: packages/fireflow-types/src/execution/services/dbos-types.ts:190

Integration context inherited from parent (API keys, service credentials)

---

nodeIds

nodeIds: string[]

Defined in: packages/fireflow-types/src/execution/services/dbos-types.ts:176

Node IDs belonging to this branch

---

options?

optional options: Record<string, unknown>

Defined in: packages/fireflow-types/src/execution/services/dbos-types.ts:192

Execution options inherited from parent (timeouts, debug settings)

---

parentWorkflowId

parentWorkflowId: string

Defined in: packages/fireflow-types/src/execution/services/dbos-types.ts:178

Parent workflow ID (for reading boundary edge values via getEvent)

---

rootExecutionId

rootExecutionId: string

Defined in: packages/fireflow-types/src/execution/services/dbos-types.ts:184

Root execution ID for the entire execution tree

---

runnerId?

optional runnerId: string

Defined in: packages/fireflow-types/src/execution/services/dbos-types.ts:188

Runner ID propagated from parent ExecutionContext (for VFS access)

---

userId?

optional userId: string

Defined in: packages/fireflow-types/src/execution/services/dbos-types.ts:186

User ID propagated from parent ExecutionContext (for VFS access)