Skip to main content

workflowRunnerService

Workspace API

Workspace API / services/workflowRunnerService

services/workflowRunnerService

Interfaces​

ExecutionContext​

Defined in: services/workflowRunnerService.ts:81

Properties​

userId​

userId: string

Defined in: services/workflowRunnerService.ts:82

orgId​

orgId: string

Defined in: services/workflowRunnerService.ts:83

conversationId?​

optional conversationId: string

Defined in: services/workflowRunnerService.ts:84

approved?​

optional approved: boolean

Defined in: services/workflowRunnerService.ts:85

scope?​

optional scope: "organization" | "project" | "documents"

Defined in: services/workflowRunnerService.ts:86

scopeIds?​

optional scopeIds: string[]

Defined in: services/workflowRunnerService.ts:87

domainKey?​

optional domainKey: string

Defined in: services/workflowRunnerService.ts:88

mode?​

optional mode: "execute" | "dry_run"

Defined in: services/workflowRunnerService.ts:89

skillVersionId?​

optional skillVersionId: string

Defined in: services/workflowRunnerService.ts:90

Functions​

executeSkill()​

executeSkill(skillIdOrKey, input, idempotencyKey, context): AsyncGenerator<SkillSSEEvent>

Defined in: services/workflowRunnerService.ts:129

Execute a skill version with SSE streaming

Parameters​

skillIdOrKey​

string

Skill identifier (skill_id UUID or skill_key from seed data)

input​

Record<string, unknown>

User input matching skill's input_schema

idempotencyKey​

string

Unique key for this execution (prevents duplicates)

context​

ExecutionContext

Execution context (user, org, scope, etc.)

Returns​

AsyncGenerator<SkillSSEEvent>

Yields​

SSE events for real-time progress updates

getSkillByKey()​

getSkillByKey(skillKey): SeedSkillVersion | undefined

Defined in: services/workflowRunnerService.ts:879

Get skill by key (MVP-0: from seed data)

Parameters​

skillKey​

string

Returns​

SeedSkillVersion | undefined

getActiveSkillVersionId()​

getActiveSkillVersionId(skillKey): string | undefined

Defined in: services/workflowRunnerService.ts:1005

Get active skill version ID for a skill

Parameters​

skillKey​

string

Returns​

string | undefined

executeSkillWithRouting()​

executeSkillWithRouting(skillIdOrKey, input, idempotencyKey, context): AsyncGenerator<SkillSSEEvent>

Defined in: services/workflowRunnerService.ts:1027

Execute a skill with VoltAgent executor

Always routes to VoltAgent executor. Legacy executor routing has been removed.

Parameters​

skillIdOrKey​

string

Skill identifier (skill_key or skill_id)

input​

Record<string, unknown>

User input matching skill's input_schema

idempotencyKey​

string

Unique key for this execution (prevents duplicates)

context​

ExecutionContext

Execution context (user, org, scope, etc.)

Returns​

AsyncGenerator<SkillSSEEvent>

Yields​

SSE events for real-time progress updates