Struct RealtimeApi 

pub struct RealtimeApi { /* private fields */ }

Realtime API for voice interactions.

Implementations

impl RealtimeApi

pub fn connect(&self, model: impl Into<String>) -> RealtimeSessionBuilder

Start building a realtime session.

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)
    .instructions("You are a helpful voice assistant.")
    .start()
    .await?;

pub fn resume(&self, config: SessionConfig) -> RealtimeSessionBuilder

Resume a realtime session from an existing session configuration.

This is useful when reconnecting after a dropped socket and you want to restore the same voice/tool/instruction settings in one call.

Example

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

let client = XaiClient::from_env()?;

let config = SessionConfig::new("grok-4")
    .voice(Voice::Rex)
    .instructions("Resume with prior settings");

let session = client.realtime().resume(config).start().await?;

Trait Implementations

impl Clone for RealtimeApi

fn clone(&self) -> RealtimeApi

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RealtimeApi

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

Formats the value using the given formatter.