Vercel.AI.Xai

API reference

xAI provider.

Classes

Type	Summary
XaiClientSecret	Client secret returned by /realtime/clientsecrets.
XaiFileDeleteResult	Result of deleting an xAI file.
XaiFileDownload	Downloaded xAI file bytes.
XaiFileMetadata	Metadata stored under providerMetadata.xai. A field is null when the response did not return it.
XaiFileResult	Result of an xAI file upload or metadata read.
XaiFiles	xAI Files API at {base}/files.
XaiFileSearchOptions	Arguments of String). Maps to fileSearchArgsSchema.
XaiFileUpload	Bytes, base64, or a stream uploaded to xAI.
XaiImageGenerationOptions	Arguments of String). Maps to imageGenerationArgsSchema.
XaiMcpServerOptions	Arguments of String). Maps to mcpServerArgsSchema.
XaiProvider	xAI provider at https://api.x.ai/v1. LanguageModel(string) returns the Responses API model, as upstream does.
XaiRealtimeModel	xAI realtime voice model.
XaiReasoning	Reasoning text that carries the xAI Responses item id and encrypted content.
XaiResponsesLanguageModel	xAI Responses API language model. Generate and stream requests post to /responses. Pass xAI provider-defined tools with JsonElement) and the ids xai.websearch, xai.xsearch, xai.codeexecution, xai.viewimage, xai.viewxvideo, xai.imagegeneration, xai.filesearch, and xai.mcp.
XaiServiceCollectionExtensions	Registers XaiProvider.
XaiTools	Factories for the xAI provider-defined tools. Each returns a Tool that xAI runs. Maps to xai.tools. The name is the name the model and the results use. It defaults to the tool’s wire name.
XaiWebSearchOptions	Arguments of String). Maps to webSearchArgsSchema.
XaiXSearchOptions	Arguments of String). Maps to xSearchArgsSchema.

Enums

Type	Summary
XaiImageGenerationAction	Restricts what the xai.imagegeneration tool can do. Maps to the action argument.