Struct SessionConfig 

pub struct SessionConfig {

    pub session_id: Option<String>,
    pub model: Option<String>,
    pub config_dir: Option<PathBuf>,
    pub tools: Vec<Tool>,
    pub system_message: Option<SystemMessageConfig>,
    pub available_tools: Option<Vec<String>>,
    pub excluded_tools: Option<Vec<String>>,
    pub provider: Option<ProviderConfig>,
    pub streaming: bool,
    pub mcp_servers: Option<HashMap<String, Value>>,
    pub custom_agents: Option<Vec<CustomAgentConfig>>,
    pub skill_directories: Option<Vec<String>>,
    pub disabled_skills: Option<Vec<String>>,
    pub request_permission: Option<bool>,
    pub infinite_sessions: Option<InfiniteSessionConfig>,
    pub request_user_input: Option<bool>,
    pub reasoning_effort: Option<String>,
    pub working_directory: Option<String>,
    pub hooks: Option<SessionHooks>,
    pub auto_byok_from_env: bool,
}

Configuration for creating a new session.

Fields

session_id: Option<String>

model: Option<String>

config_dir: Option<PathBuf>

tools: Vec<Tool>

system_message: Option<SystemMessageConfig>

available_tools: Option<Vec<String>>

excluded_tools: Option<Vec<String>>

provider: Option<ProviderConfig>

streaming: bool

mcp_servers: Option<HashMap<String, Value>>

custom_agents: Option<Vec<CustomAgentConfig>>

skill_directories: Option<Vec<String>>

disabled_skills: Option<Vec<String>>

request_permission: Option<bool>

infinite_sessions: Option<InfiniteSessionConfig>

Infinite session configuration for automatic context compaction.

request_user_input: Option<bool>

Whether to request user input forwarding from the server. When true, userInput.request callbacks will be sent to the SDK.

reasoning_effort: Option<String>

Reasoning effort level: “low”, “medium”, “high”, or “xhigh”.

working_directory: Option<String>

Working directory for the session.

hooks: Option<SessionHooks>

Session hooks for pre/post tool use, session lifecycle, etc.

auto_byok_from_env: bool

If true and provider/model not explicitly set, load from COPILOT_SDK_BYOK_* env vars.

Default: false (explicit configuration preferred over environment variables)

Trait Implementations

impl Clone for SessionConfig

fn clone(&self) -> SessionConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionConfig

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

Formats the value using the given formatter.

impl Default for SessionConfig

fn default() -> SessionConfig

Returns the “default value” for a type.

impl Serialize for SessionConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.