Agent Orchestrator

Interfaces

Interfaces

ClaudeAgentConfig

Claude Agent SDK configuration options

Properties:

PropertyTypeRequiredDescription
apiKeystringYesAnthropic API key
modelstring | undefinedNoClaude model to use
cwdstring | undefinedNoWorking directory for file operations
maxTurnsnumber | undefinedNoMaximum number of conversation turns
customSystemPromptstring | undefinedNoCustom system prompt (will be appended to base prompt)
verboseboolean | undefinedNoEnable verbose logging

AgentExecutionResult

Execution result from Claude Agent SDK

Properties:

PropertyTypeRequiredDescription
successbooleanYesWhether the execution was successful
messagestringYesResult message or error
filesModifiedstring[] | undefinedNoFiles modified during execution
commandsExecutedstring[] | undefinedNoCommands executed
conversationHistory{ role: "user" | "assistant"; content: string; timestamp: string; }[] | undefinedNoFull conversation history
error{ message: string; stack?: string; code?: string; } | undefinedNoError details if execution failed

HeadlessExecutionConfig

Headless execution configuration

Properties:

PropertyTypeRequiredDescription
clientIRxDBClientYesRxDB client for approval workflow and output persistence
orgIdstringYesOrganization ID for approval requests
userIdstringYesUser ID for approval requests
taskIdstringYesTask ID for tracking
projectIdstring | undefinedNoProject ID for approval requests (optional)
conversationConfigPartial<ConversationConfig> | undefinedNoConversation configuration (optional)
serverUrlstringYesRxDB server URL for REST client operations
authTokenstringYesAuthentication token for REST client
domainIdstringYesDomain ID for REST client
loggerLoggingService | undefinedNoLogging service for persisting logs to database (optional)

ClaudeHeadlessOutput

JSON output from Claude Code headless mode (actual format)

Claude Code --output-format json returns a different structure than initially expected. This interface matches the actual output format.

Properties:

PropertyTypeRequiredDescription
typestringYesResult type (e.g., "result")
subtypestringYesResult subtype (e.g., "success", "error")
is_errorbooleanYesWhether this is an error
duration_msnumberYesDuration in milliseconds
duration_api_msnumberYesAPI duration in milliseconds
num_turnsnumberYesNumber of conversation turns
resultstringYesResult message
session_idstringYesSession ID
total_cost_usdnumberYesTotal cost in USD
usage{ input_tokens: number; cache_creation_input_tokens: number; cache_read_input_tokens: number; output_tokens: number; server_tool_use?: { web_search_requests: number; }; service_tier: string; cache_creation?: { ephemeral_1h_input_tokens: number; ephemeral_5m_input_tokens: number; }; }YesToken usage statistics
modelUsageRecord<string, any>YesModel usage (empty object in current format)
permission_denialsany[]YesPermission denials
uuidstringYesUnique identifier

LogEntry

Log entry structure

Properties:

PropertyTypeRequiredDescription
timestampstringYesTimestamp (ISO 8601)
levelLogLevelYesLog level
sourcestringYesLog source (orchestrator, worker, executor, etc.)
messagestringYesLog message
contextRecord<string, any> | undefinedNoAdditional context data
error{ message: string; stack?: string; code?: string; } | undefinedNoError details if applicable

ConversationEntry

Conversation turn entry

Properties:

PropertyTypeRequiredDescription
timestampstringYesTimestamp (ISO 8601)
turnnumberYesTurn number (1-indexed)
role"user" | "assistant"YesRole (user or assistant)
contentstringYesMessage content
metadataRecord<string, any> | undefinedNoAdditional metadata

FileChangeEntry

File change entry

Properties:

PropertyTypeRequiredDescription
timestampstringYesTimestamp (ISO 8601)
pathstringYesFile path relative to working directory
type"created" | "modified" | "deleted"YesChange type
sizenumber | undefinedNoFile size in bytes
contentstring | undefinedNoFile content snapshot (for small files)
metadataRecord<string, any> | undefinedNoAdditional metadata

FileSystemLoggerConfig

FileSystem Logger configuration

Properties:

PropertyTypeRequiredDescription
taskIdstringYesTask ID (used for directory name)
baseLogsPathstring | undefinedNoBase logs directory path
sourcestringYesLog source identifier (orchestrator, worker, etc.)
inContainerboolean | undefinedNoWhether running in container (affects path resolution)
verboseboolean | undefinedNoEnable verbose logging to console

WorktreeConfig

Git worktree configuration

Properties:

PropertyTypeRequiredDescription
basePathstring | undefinedNoBase path for all git worktrees
maxWorktreesnumber | undefinedNoMaximum number of concurrent worktrees
verboseboolean | undefinedNoEnable verbose logging

WorktreeInfo

Worktree information

Properties:

PropertyTypeRequiredDescription
idstringYesUnique worktree ID
pathstringYesAbsolute path to worktree directory
branchstringYesBranch name
taskIdstringYesTask ID associated with this worktree
codebaseIdstringYesCodebase ID
repoUrlstringYesRepository URL
createdAtDateYesCreated timestamp
lastAccessedAtDateYesLast accessed timestamp

OrchestratorConfig

Orchestrator configuration

Properties:

PropertyTypeRequiredDescription
agentIdstringYesUnique orchestrator agent ID
orgIdstringYesOrganization ID
serverUrlstringYesRxDB server URL
authTokenstringYesAuthentication token
domainIdstringYesDomain ID
collectionsstring[]YesCollections to replicate
pollIntervalnumber | undefinedNoPolling interval in milliseconds
maxWorkersnumber | undefinedNoMaximum concurrent workers
maxRetriesnumber | undefinedNoMaximum connection retries
verboseboolean | undefinedNoEnable verbose logging

OrchestratorStats

Orchestrator statistics

Properties:

PropertyTypeRequiredDescription
activeWorkersnumberYes
maxWorkersnumberYes
availableWorkerSlotsnumberYes
pollCountnumberYes
tasksProcessednumberYes
uptimenumberYes

QueueEntry

Queue entry with priority information

Properties:

PropertyTypeRequiredDescription
taskTaskModelYesTask document
priorityTaskPriorityYesPriority level (1=highest, 3=lowest)
addedAtDateYesWhen the task was added to queue
lastHeartbeatDate | undefinedNoLast heartbeat update
attemptsnumberYesNumber of execution attempts

TaskQueueConfig

Task queue configuration

Properties:

PropertyTypeRequiredDescription
agentIdstringYesAgent ID to filter tasks by
orgIdstringYesOrganization ID to filter by
serverUrlstringYesRxDB server URL (for REST client)
authTokenstringYesAuthentication token (for REST client)
domainIdstringYesDomain ID (for REST client)
heartbeatIntervalnumber | undefinedNoHeartbeat interval in milliseconds
maxRetriesnumber | undefinedNoMaximum retry attempts for blocked tasks
verboseboolean | undefinedNoEnable verbose logging

AgentConfig

Agent Types

Type definitions for autonomous agent system

Properties:

PropertyTypeRequiredDescription
agentIdstringYesAgent identification
agentNamestringYes
autoApproveApprovalPhase[]YesApproval behavior
manualApproveApprovalPhase[]Yes
maxRetriesnumberYesExecution settings
retryDelayMsnumberYes
maxConcurrentTasksnumberYes
logLevel"debug" | "info" | "warn" | "error"YesLogging configuration
logToFileboolean | undefinedNo
logFilePathstring | undefinedNo
serverUrlstringYesRxDB connection
authTokenstringYes
domainIdstringYes
userIdstringYes
orgIdstringYes
collectionsstring[]Yes
claudeApiKeystring | undefinedNoClaude API configuration
claudeModelstring | undefinedNo
claudeMaxTokensnumber | undefinedNo

AgentExecutionContext

Agent execution context

Properties:

PropertyTypeRequiredDescription
specNamestringYes
projectIdstring | undefinedNo
currentPhasestring | undefinedNo
startedAtstringYes
lastActivityAtstringYes
status"initializing" | "running" | "paused" | "completed" | "failed"Yes
errorstring | undefinedNo

WorkflowStepResult

Workflow step result

Properties:

PropertyTypeRequiredDescription
successbooleanYes
phasestringYes
actionstringYes
messagestringYes
dataanyNo
errorstring | undefinedNo

TaskExecutionResult

Task execution result

Properties:

PropertyTypeRequiredDescription
successbooleanYes
taskIdstringYes
taskNumberstringYes
statusstringYes
messagestringYes
errorstring | undefinedNo
logsstring[] | undefinedNo

ApprovalDecision

Approval decision

Properties:

PropertyTypeRequiredDescription
approvedbooleanYes
requiresManualReviewbooleanYes
phasestringYes
messagestringYes

WorkerAgentConfig

Worker agent configuration

Properties:

PropertyTypeRequiredDescription
taskIdstringYesTask ID to execute
serverUrlstringYesRxDB server URL
authTokenstringYesAuthentication token
domainIdstringYesDomain ID
orgIdstringYesOrganization ID
agentIdstringYesAgent ID
collectionsstring[]YesCollections to replicate
maxRetriesnumber | undefinedNoMaximum connection retries
worktreeBasePathstring | undefinedNoGit worktree base path
anthropicApiKeystring | undefinedNoAnthropic API key

TaskExecutionResult

Task execution result

Properties:

PropertyTypeRequiredDescription
successbooleanYesExecution success status
filesModifiedstring[] | undefinedNoFiles modified during execution
commandsExecutedstring[] | undefinedNoCommands executed
outputstring | undefinedNoExecution output
errorstring | undefinedNoError message if failed
needsHumanInputboolean | undefinedNoWhether agent needs human input
questionstring | undefinedNoQuestion for human if input needed
contextanyNoContext for the question

WorkerInfo

Worker information

Properties:

PropertyTypeRequiredDescription
workerIdstringYesUnique worker ID
containerIdstringYesDocker container ID
taskIdstringYesTask ID being processed
status"running" | "completed" | "failed" | "starting"YesWorker status
startedAtDateYesStarted timestamp
completedAtDate | undefinedNoCompleted/failed timestamp
errorstring | undefinedNoError message if failed

CircuitBreakerConfig

Circuit Breaker

Prevents cascading failures by temporarily disabling unhealthy providers.

Properties:

PropertyTypeRequiredDescription
failureThresholdnumber | undefinedNo
openDurationMsnumber | undefinedNo

LLMExecutor

LLM Executor

Abstract interface for executing coding tasks with any LLM provider.

ConversationTurn

LLM Executor Types

Provider-agnostic types for LLM execution results and configuration.

Properties:

PropertyTypeRequiredDescription
role"user" | "assistant" | "system"Yes
contentstringYes
timestampstring | undefinedNo

TokenUsage

Token usage statistics

Properties:

PropertyTypeRequiredDescription
inputTokensnumberYes
outputTokensnumberYes
cacheCreationTokensnumber | undefinedNo
cacheReadTokensnumber | undefinedNo

ExecutionDuration

Execution duration metrics

Properties:

PropertyTypeRequiredDescription
totalMsnumberYes
apiMsnumberYes

ExecutionError

Execution error details

Properties:

PropertyTypeRequiredDescription
messagestringYes
stackstring | undefinedNo
retryablebooleanYes

ExecutionResult

Provider-agnostic execution result

Properties:

PropertyTypeRequiredDescription
successbooleanYes
messagestring | undefinedNo
conversationHistoryConversationTurn[]Yes
filesModifiedstring[] | undefinedNo
commandsExecutedstring[] | undefinedNo
usageTokenUsageYes
costnumber | undefinedNo
durationExecutionDurationYes
errorExecutionError | undefinedNo

ExecutionParams

Parameters for LLM execution

Properties:

PropertyTypeRequiredDescription
taskIdstringYes
taskPromptstringYes
systemPromptstringYes
workingDirectorystringYes
maxTurnsnumber | undefinedNo
temperaturenumber | undefinedNo
maxTokensnumber | undefinedNo

ProviderInfo

Provider information

Properties:

PropertyTypeRequiredDescription
namestringYes
modelstringYes
endpointstring | undefinedNo
capabilities{ streaming: boolean; functionCalling: boolean; contextWindow: number; }Yes

HealthStatus

Health check status

Properties:

PropertyTypeRequiredDescription
healthybooleanYes
providerstringYes
latencyMsnumber | undefinedNo
messagestring | undefinedNo

OllamaConfig

Ollama provider configuration

Properties:

PropertyTypeRequiredDescription
endpointstringYes
modelstringYes

VLLMConfig

vLLM provider configuration

Properties:

PropertyTypeRequiredDescription
endpointstringYes
modelstringYes
apiKeystring | undefinedNo

ClaudeConfig

Claude provider configuration

Properties:

PropertyTypeRequiredDescription
modelstringYes
apiKeystring | undefinedNo
cliPathstring | undefinedNo

OpenAIConfig

OpenAI provider configuration

Properties:

PropertyTypeRequiredDescription
endpointstring | undefinedNo
modelstringYes
apiKeystringYes

LLMExecutorConfig

LLM executor configuration

Properties:

PropertyTypeRequiredDescription
defaultProvider"claude" | "ollama" | "vllm" | "openai"Yes
hybridMode{ enabled: boolean; simpleProvider: string; complexProvider: string; } | undefinedNo
providers{ claude?: ClaudeConfig; ollama?: OllamaConfig; vllm?: VLLMConfig; openai?: OpenAIConfig; }Yes

HttpClientConfig

HTTP Client Utility

Simple HTTP client with timeout and retry support for LLM API calls.

Properties:

PropertyTypeRequiredDescription
timeoutnumber | undefinedNo
retriesnumber | undefinedNo
headersRecord<string, string> | undefinedNo

HttpResponse

Properties:

PropertyTypeRequiredDescription
statusnumberYes
statusTextstringYes
headersHeadersYes
dataTYes
Previous
API Reference
Next
Types