Xai.Client (xai v0.2.0)

Copy Markdown View Source

The main client for interacting with xAI's gRPC APIs.

Closely modeled after xai_sdk.Client in the official Python SDK.

Example

client = Xai.Client.new(api_key: System.get_env("XAI_API_KEY"))

chat = Xai.Chat.create(client, model: "grok-4.5")
chat = Xai.Chat.append(chat, Xai.Chat.user("Hello"))
{:ok, response} = Xai.Chat.sample(chat)

For long-running operations (video, deferred), the client manages the channel.

Options

  • :api_key - falls back to XAI_API_KEY
  • :management_api_key - for Collections / management (falls back to XAI_MANAGEMENT_API_KEY)
  • :endpoint - default "api.x.ai:443"
  • :ssl - whether to use TLS for the gRPC connection, default true
  • :timeout - default 30 minutes
  • :adapter - the GRPC.Stub transport adapter, default GRPC.Client.Adapters.Gun. Both :gun and :mint are optional dependencies of this package — add whichever one you actually use to your own mix.exs. Pass adapter: GRPC.Client.Adapters.Mint to use Mint instead of Gun (no :cowlib in its dependency tree). Callers who only use Xai.Realtime (WebSocket, via websockex) never call Xai.Client.new/1 at all and need neither :gun nor :mint.

Summary

Types

t()

Functions

channel(client)

Get the raw gRPC channel (for advanced use or direct stub calls).

default_timeout(client)

Get the configured default timeout.

new(opts \\ [])

Create a new client.

Types

t()

@type t() :: %Xai.Client{
  api_key: String.t() | nil,
  channel: GRPC.Channel.t(),
  endpoint: String.t(),
  management_api_key: String.t() | nil,
  timeout: pos_integer()
}

Functions

channel(client)

@spec channel(t()) :: GRPC.Channel.t()

Get the raw gRPC channel (for advanced use or direct stub calls).

default_timeout(client)

Get the configured default timeout.

new(opts \\ [])

@spec new(keyword()) :: t()

Create a new client.