Struct Client 

pub struct Client { /* private fields */ }

Client for interacting with the Gradium API.

The client handles authentication and WebSocket connection management.

Implementations

impl Client

pub fn from_location(api_key: &str, location: Location) -> Self

Creates a new client for the specified Gradium API location.

Arguments

• api_key - Your Gradium API key
• location - The API location (EU or US)

pub fn new(api_key: &str) -> Self

Creates a new client for the production Gradium API.

Arguments

• api_key - Your Gradium API key

Example

use gradium::Client;

let client = Client::new("your-api-key");

pub fn us_prod(api_key: &str) -> Self

Creates a new client for the US production Gradium API endpoint.

Arguments

• api_key - Your Gradium API key

Example

use gradium::Client;

let client = Client::us_prod("your-api-key");

pub fn eu_prod(api_key: &str) -> Self

Creates a new client for the EU production Gradium API endpoint.

Arguments

• api_key - Your Gradium API key

Example

use gradium::Client;

let client = Client::eu_prod("your-api-key");

pub fn with_additional_header(self, key: &str, value: &str) -> Self

Adds an additional HTTP header to be sent with each request (builder pattern).

pub fn from_env( base_url: Option<String>, api_key: Option<String>, ) -> Result<Self>

Creates a new client from environment variables.

Uses GRADIUM_API_KEY and GRADIUM_BASE_URL environment variables if the corresponding parameters are None.

Arguments

• base_url - Optional base URL override. If None, uses GRADIUM_BASE_URL env var or default
• api_key - Optional API key override. If None, uses GRADIUM_API_KEY env var

Returns

A configured Client instance

Errors

Returns an error if:

• API key is not provided and GRADIUM_API_KEY is not set
• Base URL parsing fails

Example

use gradium::Client;

// Uses environment variables
let client = Client::from_env(None, None)?;

// Override API key
let client = Client::from_env(None, Some("my-key".to_string()))?;

pub fn with_api_key(self, api_key: &str) -> Self

Sets the API key for this client (builder pattern).

Arguments

• api_key - The API key to use

Example

use gradium::Client;

let client = Client::new("old-key")
    .with_api_key("new-key");

pub fn with_server_addr(self, server_addr: &str) -> Self

Sets the server address for this client (builder pattern).

Arguments

• server_addr - The server address (e.g., “eu.api.gradium.ai”)

Example

use gradium::Client;

let client = Client::new("api-key")
    .with_server_addr("localhost:8080");

pub fn with_https(self, use_https: bool) -> Self

Sets whether to use HTTPS/WSS (builder pattern).

Arguments

• use_https - true for HTTPS/WSS, false for HTTP/WS

Example

use gradium::Client;

let client = Client::new("api-key")
    .with_https(false); // Use insecure connection for local testing

pub fn with_path(self, path: &str) -> Self

Sets the base path for API endpoints (builder pattern).

Arguments

• path - The base path (e.g., “api” or “v1”)

Example

use gradium::Client;

let client = Client::new("api-key")
    .with_path("v2");

pub fn with_base_url(self, base_url: &str) -> Result<Self>

Sets the server configuration from a complete base URL (builder pattern).

Parses the URL to extract the server address, port, scheme, and path.

Arguments

• base_url - Complete base URL (e.g., “https://eu.api.gradium.ai/api”)

Returns

The updated client on success

Errors

Returns an error if the URL cannot be parsed

Example

use gradium::Client;

let client = Client::new("api-key")
    .with_base_url("https://custom.gradium.ai:8443/v2")?;

pub fn ws_url(&self, endpoint: &str) -> String

Constructs the full WebSocket URL for a given endpoint.

Arguments

• endpoint - The API endpoint path (e.g., “speech/tts”)

Returns

A fully qualified WebSocket URL string

pub fn http_url(&self, endpoint: &str) -> String

pub async fn ws_connect(&self, endpoint: &str) -> Result<WebSocket>

Establishes a WebSocket connection to the specified endpoint.

This method handles authentication by adding the API key to the request headers.

Arguments

• endpoint - The API endpoint to connect to (e.g., “speech/tts”)

Returns

A WebSocket connection on success

Errors

Returns an error if the connection fails or if the API key is invalid

pub async fn tts(&self, text: &str, setup: Setup) -> Result<TtsResult>

Performs a one-shot text-to-speech conversion.

This is a convenience method that delegates to crate::tts::tts.

Arguments

• text - The text to synthesize
• setup - TTS configuration

Returns

A TtsResult containing the complete audio data

Errors

Returns an error if the TTS operation fails

pub async fn tts_stream(&self, setup: Setup) -> Result<TtsStream>

Creates a new TTS stream for real-time text-to-speech.

This is a convenience method that delegates to crate::tts::tts_stream.

Arguments

• setup - TTS configuration

Returns

A TtsStream for streaming TTS operations

Errors

Returns an error if the stream cannot be created

pub async fn tts_multiplex(&self) -> Result<TtsMultiplexStream>

Opens a multiplexing TTS WebSocket connection.

Returns a TtsMultiplexStream that allows sending multiple independent TTS requests over a single WebSocket, tracked by client_req_id.

Errors

Returns an error if the WebSocket connection fails

pub async fn stt(&self, audio: Vec<u8>, setup: Setup) -> Result<SttResult>

Performs a one-shot speech-to-text transcription.

This is a convenience method that delegates to crate::stt::stt.

Arguments

• audio - Raw audio data to transcribe
• setup - STT configuration

Returns

An SttResult containing the transcription

Errors

Returns an error if the STT operation fails

pub async fn stt_stream(&self, setup: Setup) -> Result<SttStream>

Creates a new STT stream for real-time speech recognition.

This is a convenience method that delegates to crate::stt::stt_stream.

Arguments

• setup - STT configuration

Returns

An SttStream for streaming STT operations

Errors

Returns an error if the stream cannot be created

pub async fn credits(&self) -> Result<CreditsResponse>

pub async fn usage(&self) -> Result<UsageResponse>

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.