Struct XaiClient 

pub struct XaiClient { /* private fields */ }

The main xAI API client.

Use this client to interact with all xAI API endpoints.

Example

use xai_rust::XaiClient;

// Create from API key
let client = XaiClient::new("your-api-key")?;

// Or use the builder
let client = XaiClient::builder()
    .api_key("your-api-key")
    .timeout_secs(300)
    .build()?;

// Or load from XAI_API_KEY environment variable
let client = XaiClient::from_env()?;

Implementations

impl XaiClient

pub fn new(api_key: impl Into<String>) -> Result<Self>

Create a new client with the given API key.

Uses default configuration (global endpoint, 120s timeout).

Errors

Returns an error if the API key contains invalid header characters or the HTTP client cannot be created.

pub fn from_env() -> Result<Self>

Create a new client from the XAI_API_KEY environment variable.

pub fn builder() -> XaiClientBuilder

Create a new client builder.

pub fn sync(&self) -> Result<SyncXaiClient>

Create a blocking/sync facade from this async client.

The sync facade is intended for non-async applications and should not be used from inside an active async runtime.

pub fn into_sync(self) -> Result<SyncXaiClient>

Convert this async client into a blocking/sync facade.

The sync facade is intended for non-async applications and should not be used from inside an active async runtime.

pub fn with_config(config: ClientConfig) -> Result<Self>

Create a client with the given configuration.

pub fn base_url(&self) -> &str

Get the base URL for API requests.

pub fn responses(&self) -> ResponsesApi

Access the Responses API.

The Responses API is the primary endpoint for chat interactions.

Example

use xai_rust::{XaiClient, Role};

let client = XaiClient::from_env()?;

let response = client.responses()
    .create("grok-4")
    .message(Role::User, "Hello!")
    .send()
    .await?;

pub fn auth(&self) -> AuthApi

Access the Auth API.

Example

use xai_rust::XaiClient;

let client = XaiClient::from_env()?;
let key = client.auth().api_key().await?;
println!("Authenticated as: {}", key.api_key);

pub fn chat(&self) -> ChatApi

Access the Chat Completions API (legacy).

Note: The Chat Completions API is deprecated. Use responses() instead.

pub fn images(&self) -> ImagesApi

Access the Images API.

Example

use xai_rust::XaiClient;

let client = XaiClient::from_env()?;

let response = client.images()
    .generate("grok-2-image", "A cat in a tree")
    .send()
    .await?;

pub fn videos(&self) -> VideosApi

Access the Videos API.

Example

use xai_rust::XaiClient;

let client = XaiClient::from_env()?;
let video = client.videos().get("video-123").await?;
println!("Video: {:?}", video.id);

pub fn files(&self) -> FilesApi

Access the Files API.

Example

use xai_rust::XaiClient;

let client = XaiClient::from_env()?;

let files = client.files().list().await?;

pub fn models(&self) -> ModelsApi

Access the Models API.

Example

use xai_rust::XaiClient;

let client = XaiClient::from_env()?;

let models = client.models().list().await?;

pub fn realtime(&self) -> RealtimeApi

Access the Realtime API for voice interactions.

Example

use xai_rust::{XaiClient, Voice, AudioFormat};

let client = XaiClient::from_env()?;

let session = client.realtime()
    .connect("grok-4")
    .voice(Voice::Ara)
    .audio_format(AudioFormat::Pcm16)
    .start()
    .await?;

pub fn batch(&self) -> BatchApi

Access the Batch API for processing multiple requests.

Example

use xai_rust::XaiClient;

let client = XaiClient::from_env()?;

let batch = client.batch().create("my-batch").await?;
println!("Created batch: {}", batch.id);

pub fn collections(&self) -> CollectionsApi

Access the Collections API for document storage and retrieval.

Example

use xai_rust::XaiClient;

let client = XaiClient::from_env()?;

let collection = client.collections().create_named("my-docs").await?;
println!("Created collection: {}", collection.id);

pub fn documents(&self) -> DocumentsApi

Access the Documents API.

Example

use xai_rust::api::DocumentsSearchRequest;
use xai_rust::XaiClient;

let client = XaiClient::from_env()?;
let response = client.documents().search(DocumentsSearchRequest::new("query")).await?;
println!("Found {} results", response.results.len());

pub fn embeddings(&self) -> EmbeddingsApi

Access the Embeddings API.

Example

use serde_json::json;
use xai_rust::api::EmbeddingsRequest;
use xai_rust::XaiClient;

let client = XaiClient::from_env()?;
let response = client
    .embeddings()
    .create(EmbeddingsRequest::new("text-embedding", json!("Hello")))
    .await?;
println!("embedding result {}",
    response.data.len());

pub fn tokenizer(&self) -> TokenizerApi

Access the Tokenizer API for counting tokens.

Example

use xai_rust::XaiClient;

let client = XaiClient::from_env()?;

let count = client.tokenizer()
    .count_tokens("grok-4", "Hello, world!")
    .await?;

println!("Token count: {}", count);

Trait Implementations

impl Clone for XaiClient

fn clone(&self) -> XaiClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for XaiClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.