Skip to main content
Version: 0.15.0

Function: runQuery()

function runQuery(prompt, options): AgentRun;

Defined in: core/runner.ts:118

Thin wrapper around the SDK's own query(): same two-argument shape (a plain string for a one-shot run, or an AsyncIterable<SDKUserMessage> — see createInputQueue() — for a multi-turn chat), translating its raw message stream into AgentEvents as described above. Every other control surface of the underlying Query (interrupt, close, supportedCommands) is passed through unchanged.

Parameters​

ParameterType
promptstring | AsyncIterable<SDKUserMessage, any, any>
optionsOptions

Returns​

AgentRun