Interface: RunResult

Generated from the public TypeScript API.

Terminal Agent result. Execution-limit and abort subtypes resolve normally; inspect isError rather than relying on rejection.

​

Example

const result = await agent.run("Summarize the repository.")
if (result.isError) console.error(result.subtype)
else console.log(result.text)

​

Extends

• ResultMessage

​

Properties

​

durationMs

durationMs: number;

​

Inherited from

ResultMessage.durationMs

---

​

error?

optional error?: object;

​

cause?

optional cause?: unknown;

​

message

message: string;

​

Inherited from

ResultMessage.error

---

​

isError

isError: boolean;

Exactly subtype !== "success".

---

​

messageId?

optional messageId?: string;

​

Inherited from

ResultMessage.messageId

---

​

modelUsage?

optional modelUsage?: Record<string, ModelUsageSummary>;

​

Inherited from

ResultMessage.modelUsage

---

​

parentMessageId?

optional parentMessageId?: string;

​

Inherited from

ResultMessage.parentMessageId

---

​

sessionId

sessionId: string;

​

Inherited from

ResultMessage.sessionId

---

​

stopReason?

optional stopReason?: string;

​

Inherited from

ResultMessage.stopReason

---

​

structuredOutput?

optional structuredOutput?: unknown;

​

Inherited from

ResultMessage.structuredOutput

---

​

subtype

subtype:
  | "success"
  | "error_aborted"
  | "error_during_execution"
  | "error_max_turns"
  | "error_max_budget"
  | "error_max_structured_output_retries";

​

Inherited from

ResultMessage.subtype

---

​

text

text: string;

Final assistant text, or "" when the terminal message had no text.

​

Overrides

ResultMessage.text

---

​

totalCostUsd?

optional totalCostUsd?: number;

​

Inherited from

ResultMessage.totalCostUsd

---

​

turns

turns: number;

​

Inherited from

ResultMessage.turns

---

​

usage?

optional usage?: UsageSummary;

​

Inherited from

ResultMessage.usage