DocsCommonruntimeRuntimeInput
Package: @hexos/common

Input payload for a conversation turn, containing the user message and context.

Passed to AgentRuntime.stream() or invoke() to initiate a conversation turn. The context field carries arbitrary frontend data that becomes available to tools via ToolContext.frontendContext.

Related: RuntimeOutput is the non-streaming response, RuntimeEvent is the streaming response.

interface RuntimeInput {
    message: string;
    conversationId: string;
    context?: Record<string, unknown>;
    userId?: string;
}

message

string

conversationId

string

context

Record

userId

string