Struct SessionOptions 

pub struct SessionOptions {
    pub model: Option<String>,
    pub permission_mode: Option<PermissionMode>,
    pub max_budget_usd: Option<f64>,
    pub max_turns: Option<u32>,
    pub max_thinking_tokens: Option<u32>,
    pub system_prompt: Option<String>,
    pub include_partial_messages: bool,
}

Simplified session options for V2 API

SessionOptions contains only the most commonly used configuration parameters, making it easier to configure Claude compared to the full ClaudeAgentOptions.

For advanced configuration, convert to ClaudeAgentOptions using .into().

Example

use claude_agent_sdk::v2::SessionOptions;
use claude_agent_sdk::v2::PermissionMode;

// Default configuration
let options = SessionOptions::default();

// Custom configuration
let options = SessionOptions::builder()
    .model("claude-sonnet-4-20250514".to_string())
    .max_turns(10)
    .permission_mode(PermissionMode::BypassPermissions)
    .build();

Fields

model: Option<String>

Model to use (None = system default)

permission_mode: Option<PermissionMode>

Permission mode for tool execution

max_budget_usd: Option<f64>

Maximum budget in USD (None = no limit)

max_turns: Option<u32>

Maximum number of conversation turns

max_thinking_tokens: Option<u32>

Maximum thinking tokens for extended thinking

system_prompt: Option<String>

Custom system prompt

include_partial_messages: bool

Whether to include partial messages in stream

Implementations

impl SessionOptions

pub fn builder() -> SessionOptionsBuilder<((), (), (), (), (), (), ())>

Create a builder for building SessionOptions. On the builder, call .model(...)(optional), .permission_mode(...)(optional), .max_budget_usd(...)(optional), .max_turns(...)(optional), .max_thinking_tokens(...)(optional), .system_prompt(...)(optional), .include_partial_messages(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of SessionOptions.

Trait Implementations

impl Clone for SessionOptions

fn clone(&self) -> SessionOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionOptions

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

Formats the value using the given formatter.

impl Default for SessionOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SessionOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<SessionOptions> for ClaudeAgentOptions

fn from(options: SessionOptions) -> Self

Converts to this type from the input type.

impl Serialize for SessionOptions

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

where __S: Serializer,

Serialize this value into the given Serde serializer.