Coordinator

Interfaces

Interfaces

RunResult

Result of a single coordinator run

Properties:

PropertyTypeRequiredDescription
dispatchedDispatchResult[]Yes
healthHealthCheckResultYes
timestampstringYes

HealthCheckResult

Result of health check

Properties:

PropertyTypeRequiredDescription
healthystring[]Yes
offlinestring[]Yes
errorsstring[]Yes

AgentDefinition

Agent definition for session creation

Properties:

PropertyTypeRequiredDescription
namestringYes
instructionsstringYes
toolsstring[]Yes
model{ claude: string; }Yes

AgentInfo

Agent information from TeamMember

Properties:

PropertyTypeRequiredDescription
teamMemberIdstringYes
namestringYes
agentDefinitionstringYes
sessionIdstring | undefinedNo
statusAgentStatusYes
lastHeartbeatstring | undefinedNo
reportsTostring | undefinedNo

TaskAssignment

Task assignment from FlowState

Properties:

PropertyTypeRequiredDescription
taskIdstringYes
titlestringYes
descriptionstring | undefinedNo
assignedAgentstringYes
milestoneIdstring | undefinedNo
projectIdstring | undefinedNo
statusstringYes
claimedAtstring | undefinedNo

TaskDispatchMessage

Message sent to OpenClaw session

Properties:

PropertyTypeRequiredDescription
type"task_assignment"Yes
taskIdstringYes
titlestringYes
descriptionstring | undefinedNo
context{ milestoneId?: string; projectId?: string; orgId: string; }Yes

CreateSessionRequest

OpenClaw session creation request

Properties:

PropertyTypeRequiredDescription
agentNamestringYes
systemPromptstringYes
toolsstring[]Yes
modelstringYes

SessionResponse

OpenClaw session response

Properties:

PropertyTypeRequiredDescription
sessionIdstringYes
status"active" | "stopped" | "error"Yes

LifecycleResult

Result of lifecycle operation

Properties:

PropertyTypeRequiredDescription
agentNamestringYes
teamMemberIdstringYes
action"stopped" | "started" | "restarted" | "failed"Yes
sessionIdstring | undefinedNo
errorstring | undefinedNo

DispatchResult

Result of task dispatch

Properties:

PropertyTypeRequiredDescription
taskIdstringYes
agentNamestringYes
successbooleanYes
errorstring | undefinedNo
Previous
API Reference
Next
Types