Struct PortkeyConfig 

pub struct PortkeyConfig { /* private fields */ }

Configuration for the Portkey API client.

This struct holds all the necessary configuration parameters for creating and using a Portkey API client, including authentication credentials, API endpoint information, and HTTP client settings.

Examples

Creating a config with virtual key:

use portkey_sdk::PortkeyConfig;
use portkey_sdk::builder::AuthMethod;

let config = PortkeyConfig::builder()
    .with_api_key("your-portkey-api-key")
    .with_auth_method(AuthMethod::virtual_key("your-virtual-key"))
    .build()
    .unwrap();

Creating a config with provider auth:

use portkey_sdk::PortkeyConfig;
use portkey_sdk::builder::AuthMethod;

let config = PortkeyConfig::builder()
    .with_api_key("your-portkey-api-key")
    .with_auth_method(AuthMethod::provider_auth("openai", "Bearer sk-..."))
    .build()
    .unwrap();

Creating a config from environment:

// Requires PORTKEY_API_KEY and PORTKEY_VIRTUAL_KEY environment variables
let config = PortkeyConfig::from_env().unwrap();

Implementations

impl PortkeyConfig

pub fn builder() -> PortkeyBuilder

Creates a new configuration builder.

This is the recommended way to construct a PortkeyConfig.

Examples

let config = PortkeyConfig::builder()
    .with_api_key("your-api-key")
    .build()
    .unwrap();

pub fn build_client(self) -> Result<PortkeyClient>

Creates a new Portkey API client using this configuration.

Examples

let config = PortkeyConfig::builder()
    .with_api_key("your-api-key")
    .build()
    .unwrap();

let client = config.build_client().unwrap();

pub fn api_key(&self) -> &str

Returns the API key.

pub fn masked_api_key(&self) -> String

Returns a masked version of the API key for safe display/logging.

Shows the first 4 characters followed by “”, or just “” if the key is shorter than 4 characters.

pub fn auth_method(&self) -> &AuthMethod

Returns the authentication method.

pub fn base_url(&self) -> &str

Returns the base URL.

pub fn timeout(&self) -> Duration

Returns the timeout duration.

pub fn trace_id(&self) -> Option<&str>

Returns the trace ID, if set.

pub fn metadata(&self) -> Option<&HashMap<String, Value>>

Returns the metadata, if set.

pub fn cache_namespace(&self) -> Option<&str>

Returns the cache namespace, if set.

pub fn cache_force_refresh(&self) -> Option<bool>

Returns the cache force refresh flag, if set.

pub fn from_env() -> Result<Self>

Creates a configuration from environment variables.

Environment Variables

Required:

• PORTKEY_API_KEY - Your Portkey API key

Authentication (choose one):

• PORTKEY_VIRTUAL_KEY - Virtual key for managed provider credentials
• PORTKEY_PROVIDER + PORTKEY_AUTHORIZATION - Direct provider auth
• PORTKEY_CONFIG - Config ID for complex routing

Optional:

• PORTKEY_CUSTOM_HOST - Custom host URL (with provider auth)
• PORTKEY_BASE_URL - Base URL for the API
• PORTKEY_TIMEOUT_SECS - Request timeout in seconds
• PORTKEY_TRACE_ID - Trace ID for request tracking
• PORTKEY_CACHE_NAMESPACE - Cache namespace
• PORTKEY_CACHE_FORCE_REFRESH - Force cache refresh (true/false)

Examples

# Virtual key authentication
export PORTKEY_API_KEY=your-portkey-api-key
export PORTKEY_VIRTUAL_KEY=your-virtual-key

# Provider authentication
export PORTKEY_API_KEY=your-portkey-api-key
export PORTKEY_PROVIDER=openai
export PORTKEY_AUTHORIZATION="Bearer sk-..."

# Config-based authentication
export PORTKEY_API_KEY=your-portkey-api-key
export PORTKEY_CONFIG=pc-config-123

Trait Implementations

impl Clone for PortkeyConfig

fn clone(&self) -> PortkeyConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PortkeyConfig

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

Formats the value using the given formatter.