0
Fork 0
mirror of https://github.com/TanStack/ai.git synced 2026-11-16 19:38:41 +00:00
ai/docs/reference/interfaces/RunErrorEvent.md
github-actions[bot] 1999af2267
docs: regenerate API documentation (#1260)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2026-08-28 11:42:19 +02:00

2.1 KiB

id title
RunErrorEvent RunErrorEvent

Interface: RunErrorEvent

Defined in: packages/ai/src/types.ts:1225

Emitted when an error occurs during a run.

@ag-ui/core provides: message, code? Spec usage[] is provider/model token counts. Interrupt errors live in metadata.tanstack.interruptErrors.

Extends

  • Pick<AGUIRunErrorEvent, "message" | "code" | "timestamp" | "rawEvent">

Properties

error?

optional error?: object;

Defined in: packages/ai/src/types.ts:1238

Nested payload kept for in-process / durability consumers.

code?

optional code?: string;

message

message: string;

metadata?

optional metadata?: object & Record<string, any>;

Defined in: packages/ai/src/types.ts:1239

Type Declaration

tanstack?
optional tanstack?: TanStackRunMetadata;

model?

optional model?: string;

Defined in: packages/ai/src/types.ts:1236

Restored on the client from metadata.tanstack.


runId?

optional runId?: string;

Defined in: packages/ai/src/types.ts:1234

Restored on the client from metadata.tanstack.


threadId?

optional threadId?: string;

Defined in: packages/ai/src/types.ts:1232

Restored on the client from metadata.tanstack.


type

type: RUN_ERROR;

Defined in: packages/ai/src/types.ts:1229


usage?

optional usage?: 
  | TokenUsage<ProviderUsageDetails>
  | SpecTokenUsage[];

Defined in: packages/ai/src/types.ts:1230