Skip to main content

voltagentClient

Workspace API

Workspace API / services/voltagentClient

services/voltagentClient

Interfaces​

CheckpointState​

Defined in: services/voltagentClient.ts:137

Checkpoint state interface

Properties​

workflowRunId​

workflowRunId: string

Defined in: services/voltagentClient.ts:138

voltAgentRunId​

voltAgentRunId: string

Defined in: services/voltagentClient.ts:139

stepIndex​

stepIndex: number

Defined in: services/voltagentClient.ts:140

stepOutputs​

stepOutputs: Record<string, unknown>[]

Defined in: services/voltagentClient.ts:141

variables​

variables: Record<string, unknown>

Defined in: services/voltagentClient.ts:142

resumeToken​

resumeToken: string

Defined in: services/voltagentClient.ts:143

createdAt​

createdAt: Date

Defined in: services/voltagentClient.ts:144

expiresAt​

expiresAt: Date

Defined in: services/voltagentClient.ts:145

Functions​

getAgents()​

getAgents(): Promise<object[]>

Defined in: services/voltagentClient.ts:71

Get list of available agents from VoltAgent service

Returns​

Promise<object[]>

getAgentIds()​

getAgentIds(): Promise<string[]>

Defined in: services/voltagentClient.ts:100

Get agent IDs (for backward compatibility)

Returns​

Promise<string[]>

reloadAgents()​

reloadAgents(): Promise<{ success: boolean; data?: { codeAgents: number; dbAgents: number; merged: number; conflicts: number; registrySync?: { added: number; updated: number; removed: number; }; }; error?: string; }>

Defined in: services/voltagentClient.ts:116

Reload agents registry in VoltAgent service.

This endpoint triggers VoltAgent to:

  1. Load latest agents from database
  2. Merge with code-based agents
  3. Sync the internal AgentRegistry singleton (critical for agent availability)

The registrySync field in the response indicates how many agents were added/updated/removed in the internal registry.

Returns​

Promise<{ success: boolean; data?: { codeAgents: number; dbAgents: number; merged: number; conflicts: number; registrySync?: { added: number; updated: number; removed: number; }; }; error?: string; }>

loadCheckpoint()​

loadCheckpoint(resumeToken): Promise<CheckpointState | null>

Defined in: services/voltagentClient.ts:151

Load a checkpoint by resume token via VoltAgent service

Parameters​

resumeToken​

string

Returns​

Promise<CheckpointState | null>

approveCheckpoint()​

approveCheckpoint(resumeToken, workflowRunId, userId?, organizationId?, additionalInput?): Promise<{ success: boolean; data?: CheckpointState; }>

Defined in: services/voltagentClient.ts:196

Approve a checkpoint via VoltAgent service

Parameters​

resumeToken​

string

workflowRunId​

string

userId?​

string

organizationId?​

string

additionalInput?​

Record<string, unknown>

Returns​

Promise<{ success: boolean; data?: CheckpointState; }>

rejectCheckpoint()​

rejectCheckpoint(resumeToken, workflowRunId?): Promise<{ success: boolean; data?: CheckpointState; }>

Defined in: services/voltagentClient.ts:240

Reject a checkpoint via VoltAgent service

Parameters​

resumeToken​

string

workflowRunId?​

string

Returns​

Promise<{ success: boolean; data?: CheckpointState; }>

executeAgent()​

executeAgent(agentKey, input, traceId): AsyncGenerator<{ type: string; data: unknown; }>

Defined in: services/voltagentClient.ts:283

Execute an agent via VoltAgent service (SSE stream)

Parameters​

agentKey​

string

Agent key/ID

input​

string

Input for the agent

traceId​

string

Trace ID for correlation

Returns​

AsyncGenerator<{ type: string; data: unknown; }>

Async generator yielding SSE events