Struct Client 

pub struct Client<E>
where
    E: XaiEnvironment + Send + Sync + 'static,
{
    pub http_client: Client,
    pub environment: E,
    pub failover_manager: Option<FailoverManager>,
}

Core HTTP client for XAI API requests. Core HTTP client for XAI API requests. XAI API client.

The main client for interacting with the XAI API. Handles HTTP communication, authentication, and error handling.

Generic Parameter

• E - Environment type implementing XaiEnvironment trait

Examples

use api_xai::{ Client, XaiEnvironmentImpl, Secret };

let secret = Secret::load_with_fallbacks( "XAI_API_KEY" )?;
let env = XaiEnvironmentImpl::new( secret )?;
let client = Client::build( env )?;

Fields

http_client: Client

HTTP client for making requests.

environment: E

Environment configuration.

failover_manager: Option<FailoverManager>

Failover manager for endpoint rotation (optional).

Implementations

impl<E> Client<E>

where E: XaiEnvironment + Send + Sync + 'static,

pub fn build(environment: E) -> Result<Self>

Builds a new client with the given environment configuration.

HTTP Client Configuration

The client is configured with resilient network settings:

• Total timeout: From environment (default 30s, tests use 120s)
• Connect timeout: 15s for DNS resolution + TCP + TLS handshake
• Pool idle timeout: 90s to reuse connections efficiently
• TCP keepalive: 60s to detect dead connections

The connect timeout is set to 15s to ensure sufficient time remains for the actual API response in production (30s total - 15s connect = 15s for API). For integration tests with 120s timeout, this leaves 105s for API processing.

These settings prevent timeout issues on slow networks while still catching genuine failures within reasonable time.

Errors

Returns XaiError::Http if the HTTP client cannot be created.

pub fn with_failover(self, endpoints: Vec<String>) -> Self

Adds failover support with multiple endpoints (requires failover feature).

Panics

Panics if endpoints list is empty.

pub fn with_failover_config( self, endpoints: Vec<String>, config: FailoverConfig, ) -> Self

Adds failover support with custom configuration (requires failover feature).

Panics

Panics if endpoints list is empty.

pub async fn post<I, O>(&self, path: &str, body: &I) -> Result<O>

where I: Serialize, O: DeserializeOwned,

Makes a POST request to the API.

Errors

Returns errors for network failures, HTTP errors, or deserialization failures.

pub async fn get<O>(&self, path: &str) -> Result<O>

where O: DeserializeOwned,

Makes a GET request to the API.

Errors

Returns errors for network failures, HTTP errors, or deserialization failures.

pub async fn post_stream<I, O>( &self, path: &str, body: &I, ) -> Result<Pin<Box<dyn Stream<Item = Result<O>> + Send + 'static>>>

where I: Serialize, O: DeserializeOwned + Send + 'static,

Makes a streaming POST request to the API (requires streaming feature).

Errors

Returns errors for network failures, HTTP errors, or SSE parsing failures.

Trait Implementations

impl<E> ClientApiAccessors<E> for Client<E>

where E: XaiEnvironment + Send + Sync + 'static,

fn chat(&self) -> Chat<'_, E>

Returns a chat completions API accessor.

fn models(&self) -> Models<'_, E>

Returns a models API accessor.

impl<E> Clone for Client<E>

where E: XaiEnvironment + Send + Sync + 'static + Clone,

fn clone(&self) -> Client<E>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E> Debug for Client<E>

where E: XaiEnvironment + Send + Sync + 'static + Debug,

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

Formats the value using the given formatter.