Skip to content
TanStackAI
Interface References

TextOptions

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

Options passed into the SDK and further piped to the AI provider.

Type Parameters

TProviderOptionsSuperset

TProviderOptionsSuperset extends Record<string, any> = Record<string, any>

TProviderOptionsForModel

TProviderOptionsForModel = TProviderOptionsSuperset

TContext

TContext = unknown

Properties

abortController?

ts
optional abortController?: AbortController;

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

AbortController for request cancellation.

Allows you to cancel an in-progress request using an AbortController. Useful for implementing timeouts or user-initiated cancellations.

Example

ts
const abortController = new AbortController();
setTimeout(() => abortController.abort(), 5000); // Cancel after 5 seconds
await chat({ ..., abortController });

See

https://developer.mozilla.org/en-US/docs/Web/API/AbortController

agentLoopStrategy?

ts
optional agentLoopStrategy?: AgentLoopStrategy;

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

approvals?

ts
optional approvals?: ReadonlyMap<string, boolean>;

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

Client approval decisions for this run, keyed by approval id. The engine populates this from approvals carried on the incoming messages. Harness adapters consult it to resolve ask-policy permission requests (the agent pauses on a risky action; the client re-runs with a decision recorded here). Undefined for direct adapter usage outside the chat engine.

capabilities?

ts
optional capabilities?: CapabilityContext;

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

Middleware capability context for this run. The engine populates it with the live middleware context so harness adapters that declare requires: [SomeCapability] can read provided capabilities from inside chatStream — e.g. getSandbox(options.capabilities). Capabilities are provisioned by middleware setup before the adapter runs. Undefined for direct adapter usage outside the chat engine.

context?

ts
optional context?: TContext;

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

Runtime context provided by the caller and passed to middleware and server-side tool implementations.

conversationId?

ts
optional conversationId?: string;

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

Deprecated

Use threadId instead. conversationId is the legacy pre-AG-UI name for the same concept (a stable per-conversation identifier used to correlate client/server devtools events). When conversationId is omitted, the runtime falls back to threadId automatically, so most callers can simply pass threadId (or rely on chatParamsFromRequest, which surfaces it on params).

Will be removed in a future major release.

lazyToolsConfig?

ts
optional lazyToolsConfig?: LazyToolsConfig;

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

Optional configuration for lazy-tool discovery (tools marked lazy: true). Tunes how much of each lazy tool's description appears in the discovery catalog. Optional — defaults to { includeDescription: 'none' }.

logger

ts
logger: InternalLogger;

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

Internal logger threaded from the chat entry point. Adapter implementations must call logger.request() before SDK calls, logger.provider() for each chunk received, and logger.errors() in catch blocks.

messages

ts
messages: ModelMessage<
  | string
  | ContentPart<unknown, unknown, unknown, unknown, unknown>[]
  | null>[];

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

metadata?

ts
optional metadata?: Record<string, any>;

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

Observability metadata attached to this call. Surfaced to middleware, devtools, and the event client; values may be arbitrarily structured (objects, arrays). Adapters never forward this field onto the provider wire request.

To send provider-side request metadata, use the provider's modelOptions field instead, where the provider supports one (e.g. OpenAI's and OpenRouter's metadata are both Record<string, string>).

midConversationChanges?

ts
optional midConversationChanges?: MidConversationChanges;

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

The tools and system prompts that changed between model calls. The engine sets it only when adapter.midConversationChannels has a channel that is on. tools and systemPrompts stay the full current lists, so an adapter that ignores this field sends the same request as before. Adapters resolve it with splitMidConversationChanges.

model

ts
model: string;

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

modelOptions?

ts
optional modelOptions?: TProviderOptionsForModel;

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

outputSchema?

ts
optional outputSchema?: SchemaInput;

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

Schema for structured output.

Two distinct use sites:

  1. User-facing (activity layer): accepts any SchemaInput — Zod, ArkType, Valibot, or a raw JSON Schema. The activity layer converts to JSON Schema before handing off.

  2. Adapter-facing (chatStream call): the engine populates this with a pre-converted JSON Schema only when the adapter declared supportsCombinedToolsAndSchema(modelOptions) === true. The adapter should then wire the schema into the upstream request (e.g. response_format: { type: 'json_schema', ... }, text.format, output_format, --json-schema) alongside any tools.

    How the engine then takes the object depends on combinedStructuredOutputSource():

    • 'text' (default): the final-turn assistant text is the JSON.
    • 'event': the adapter emits structured-output.complete during chatStream. Accumulated prose is not parsed.

    Adapters that did NOT declare the capability never see this field populated — the engine instead invokes structuredOutput / structuredOutputStream after the agent loop.

parentRunId?

ts
optional parentRunId?: string;

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

Parent run ID for AG-UI protocol nested run correlation. Surfaced for observability/middleware; not consumed by the LLM call.

promptCache?

ts
optional promptCache?: ResolvedPromptCache;

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

Automatic prompt caching for this request. chat() sets it. When it is absent, the adapter adds no automatic cache fields.

reasoning?

ts
optional reasoning?: ReasoningRequest;

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

How hard the model thinks, normalized by chat(). undefined: the user did not ask, so the adapter sends nothing and the provider default applies. The adapter clamps the level to the model's levels and writes its own wire field.

request?

ts
optional request?: Request | RequestInit;

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

resume?

ts
optional resume?: RunAgentResumeItem[];

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

AG-UI interrupt resume responses supplied by the client on a follow-up run. A first-party generic item carries the original request in metadata.

retry?

ts
optional retry?: object;

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

Retry a model call when the provider error has a wait time (usually a 429). chat() waits for the retryAfterMs time of the RUN_ERROR, then calls the model again. It retries only when the wait time is at most maxWaitMs and the call has streamed no output yet. The structured-output call is not retried. Off by default.

maxRetries

ts
maxRetries: number;

Extra model calls after the first, for each model call of the run. 0 means no retry. The provider SDK does its own retries first, from the maxRetries of the adapter config.

maxWaitMs?

ts
optional maxWaitMs?: number;

Longest wait time to accept, in milliseconds. Default 60 000.

runId?

ts
optional runId?: string;

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

Run ID for AG-UI protocol run correlation. When provided, this will be used in RunStartedEvent and RunFinishedEvent. If not provided, a unique ID will be generated.

state?

ts
optional state?: unknown;

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

Application state mirrored in a STATE_SNAPSHOT before an interrupt terminal.

subagentRunId?

ts
optional subagentRunId?: string;

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

AG-UI subagent run id when this chat runs as a child of another run. A child chat() passes ctx.subagentRunId. Middleware reads it as ctx.subagentRunId. Absent on a top-level run.

systemPrompts?

ts
optional systemPrompts?: SystemPrompt[];

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

System prompts to include with the request.

Accepts plain strings (the common case) or { content, metadata } objects that let providers attach typed metadata (e.g. Anthropic cache_control for prompt caching) per prompt. At the chat call site the adapter narrows metadata's type via ~types['systemPromptMetadata'] — providers that don't declare one default to never, which makes the field carry no meaningful value (TypeScript will only accept undefined there). Provider-foreign metadata that reaches an adapter via JS / as any is silently dropped, never written to the wire.

See

SystemPrompt

threadId?

ts
optional threadId?: string;

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

Thread ID for AG-UI protocol run correlation. When provided, this will be used in RunStartedEvent and RunFinishedEvent.

toolChoice?

ts
optional toolChoice?: ToolChoice<string>;

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

How the model uses the tools of this request. chat() sets it only when the request has tools. A provider value in modelOptions wins over it.

toolExecution?

ts
optional toolExecution?: "parallel" | "sequential";

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

How the server tools of one model turn run. 'parallel' (the default) starts them together, and 'sequential' runs them one at a time.

tools?

ts
optional tools?: AnyTool[];

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

wrapFetch?

ts
optional wrapFetch?: FetchWrapper;

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

Wraps the fetch of this request. The engine composes the chat() option and the middleware wrappers into one function. An adapter that supports it calls wrapFetch(baseFetch) and sends the request with the result.

Edit on GitHub
TextCompletionChunk
ChunkRecording