AgentRun
The return value of agent.run(). Dual interface inspired by fetch():
- Streaming: iterate with
for await (const event of run) { ... } - Await result:
const result = await run.result
Both can be used on the same AgentRun instance. The .result promise
resolves when the session completes (after all events have been emitted).
Example
Section titled “Example”// Streamingfor await (const event of agent.run({ input: "Hello" })) { if (event.type === "model:chunk") process.stdout.write(event.text)}
// Await resultconst { output, cost } = await agent.run({ input: "Hello" }).resultImplements
Section titled “Implements”AsyncIterable<StreamEvent>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new AgentRun(
sessionId):AgentRun
Parameters
Section titled “Parameters”sessionId
Section titled “sessionId”string
Returns
Section titled “Returns”AgentRun
Properties
Section titled “Properties”result
Section titled “result”
readonlyresult:Promise<RunResult>
Promise that resolves to the final RunResult when the session completes.
Rejects if the session fails with an unhandled error.
Methods
Section titled “Methods”[asyncIterator]()
Section titled “[asyncIterator]()”[asyncIterator]():
AsyncIterator<StreamEvent>
Async iterator — yields StreamEvents as they arrive during execution.
Returns
Section titled “Returns”AsyncIterator<StreamEvent>
Implementation of
Section titled “Implementation of”AsyncIterable.[asyncIterator]
complete()
Section titled “complete()”complete(
result):void
Signal successful completion. Emits session:end, closes the stream,
and resolves the .result promise.
Parameters
Section titled “Parameters”result
Section titled “result”Returns
Section titled “Returns”void
emit()
Section titled “emit()”emit(
event):void
Emit a stream event to all iterating consumers. Called by the agent loop.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
fail()
Section titled “fail()”fail(
error):void
Signal failure. Emits an error event, closes the stream,
and rejects the .result promise.
Parameters
Section titled “Parameters”Error
Returns
Section titled “Returns”void