XaiProvider

Namespace: Vercel.AI.Xai

public sealed class XaiProvider : OpenAICompatibleProvider

xAI provider at https://api.x.ai/v1. LanguageModel(string) returns the Responses API model, as upstream does.

Inheritance: object → ProviderBase → OpenAICompatibleProvider

View source

Constructors

XaiProvider(HttpClient, OpenAICompatibleOptions?)

public XaiProvider(HttpClient httpClient, OpenAICompatibleOptions? options = null)

Creates a provider.

Parameters

Name	Type	Description
`httpClient`	HttpClient
`options`	OpenAICompatibleOptions

View source

Fields

ApiKeyVariable

public const string ApiKeyVariable = "XAI_API_KEY"

Environment variable for the API key.

Value: string

View source

DefaultBaseUrl

public const string DefaultBaseUrl = "https://api.x.ai/v1"

Default API origin.

Value: string

View source

ProviderId

public const string ProviderId = "xai"

Provider id.

Value: string

View source

Methods

Create(OpenAICompatibleOptions?, HttpMessageHandler?)

public static XaiProvider Create(OpenAICompatibleOptions? options = null, HttpMessageHandler? handler = null)

Creates a provider. Pass a handler from tests.

Parameters

Name	Type	Description
`options`	OpenAICompatibleOptions
`handler`	HttpMessageHandler

Returns: XaiProvider

View source

CreateChatModel(string)

[Obsolete("xAI language models use the Responses API, as upstream does. Use LanguageModel or ResponsesModel. The Chat Completions model will be removed.")]
public override OpenAICompatibleLanguageModel CreateChatModel(string modelId)

Creates a Chat Completions model. Upstream xAI has no chat model; use LanguageModel(string) or ResponsesModel(string).

Parameters

Name	Type	Description
`modelId`	string

Returns: OpenAICompatibleLanguageModel

View source

FileStore()

public override IFileStore FileStore()

Returns a file store.

Returns: IFileStore

View source

Files()

public XaiFiles Files()

xAI file store.

Returns: XaiFiles

View source

LanguageModel(string)

public override ILanguageModel LanguageModel(string modelId)

Creates a Responses API model, like ResponsesModel(string). The provider id is xai.responses.

Parameters

Name	Type	Description
`modelId`	string

Returns: ILanguageModel

View source

RealtimeModel(string)

public override IRealtimeModel RealtimeModel(string modelId)

Returns a realtime model.

Parameters

Name	Type	Description
`modelId`	string

Returns: IRealtimeModel

View source

ResponsesModel(string)

public XaiResponsesLanguageModel ResponsesModel(string modelId)

Creates a Responses API model. The provider id is xai.responses.

Parameters

Name	Type	Description
`modelId`	string

Returns: XaiResponsesLanguageModel

View source