Class References
Function References
- text
- textOptions
- combineStrategies
- convertMessagesToModelMessages
- convertZodToJsonSchema
- createReplayStream
- embedding
- generateMessageId
- maxIterations
- messages
- modelMessageToUIMessage
- modelMessagesToUIMessages
- normalizeToUIMessage
- parsePartialJSON
- summarize
- toServerSentEventsStream
- toServerSentEventsResponse
- toolDefinition
- uiMessageToModelMessages
- realtimeToken
- untilFinishReason
Interface References
- AIAdapter
- AIAdapterConfig
- AgentLoopState
- AudioPart
- AudioVisualization
- BaseStreamChunk
- TextCompletionChunk
- TextOptions
- ChunkRecording
- ChunkStrategy
- ClientTool
- ContentPartSource
- ContentStreamChunk
- DefaultMessageMetadataByModality
- DocumentPart
- DoneStreamChunk
- EmbeddingOptions
- EmbeddingResult
- ErrorStreamChunk
- ImagePart
- InternalToolCallState
- JSONParser
- ModelMessage
- ProcessorResult
- ProcessorState
- RealtimeAdapter
- RealtimeClientOptions
- RealtimeConnection
- RealtimeMessage
- RealtimeSessionConfig
- RealtimeToken
- RealtimeTokenAdapter
- RealtimeTokenOptions
- ResponseFormat
- ServerTool
- StreamProcessorEvents
- StreamProcessorHandlers
- StreamProcessorOptions
- SummarizationOptions
- SummarizationResult
- TextPart
- ThinkingPart
- ThinkingStreamChunk
- Tool
- ToolCall
- ToolCallPart
- ToolCallStreamChunk
- ToolConfig
- ToolDefinition
- ToolDefinitionConfig
- ToolDefinitionInstance
- ToolInputAvailableStreamChunk
- ToolResultPart
- ToolResultStreamChunk
- UIMessage
- VideoPart
Type Alias References
- AgentLoopStrategy
- AnyClientTool
- TextStreamOptionsForModel
- TextStreamOptionsUnion
- ConstrainedContent
- ConstrainedModelMessage
- ContentPart
- ContentPartForModalities
- ExtractModalitiesForModel
- ExtractModelsFromAdapter
- InferToolInput
- InferToolName
- InferToolOutput
- MessagePart
- RealtimeEvent
- RealtimeMessagePart
- RealtimeMode
- RealtimeStatus
- ModalitiesArrayToUnion
- Modality
- StreamChunk
- ToolCallState
- ToolResultState
Variable References
chatParamsFromRequestBody
function chatParamsFromRequestBody(body): Promise<{
aguiContext: Context[];
forwardedProps: Record<string, unknown>;
messages: (
| UIMessage<unknown>
| ModelMessage<
| string
| ContentPart<unknown, unknown, unknown, unknown, unknown>[]
| null>)[];
parentRunId?: string;
resume?: RunAgentResumeItem[];
runId: string;
state: unknown;
threadId: string;
tools: object[];
}>;Defined in: packages/ai/src/utilities/chat-params.ts:204
Parse and validate an HTTP request body as an AG-UI RunAgentInput.
Returns a spread-friendly object whose messages field is suitable for passing directly to chat({ messages }). The existing convertMessagesToModelMessages handles AG-UI fan-out dedup and reasoning/activity/developer-role normalization internally.
Validated structurally against the AG-UI RunAgentInput contract without a schema library, so this package pulls in no validation runtime of its own.
Parameters#
body#
unknown
Returns#
Promise<{ aguiContext: Context[]; forwardedProps: Record<string, unknown>; messages: ( | UIMessage<unknown> | ModelMessage< | string | ContentPart<unknown, unknown, unknown, unknown, unknown>[] | null>)[]; parentRunId?: string; resume?: RunAgentResumeItem[]; runId: string; state: unknown; threadId: string; tools: object[]; }>
Throws#
An error with a migration-pointing message when the body does not conform to AG-UI RunAgentInput. Surface this as a 400 Bad Request to the client.