Struct SendRequest 

pub struct SendRequest {
    pub agent_mode: Option<SendAgentMode>,
    pub attachments: Option<Vec<Value>>,
    pub billable: Option<bool>,
    pub display_prompt: Option<String>,
    pub mode: Option<SendMode>,
    pub prepend: Option<bool>,
    pub prompt: String,
    pub request_headers: Option<HashMap<String, String>>,
    pub required_tool: Option<String>,
    pub traceparent: Option<String>,
    pub tracestate: Option<String>,
    pub wait: Option<bool>,
    /* private fields */
}

Parameters for sending a user message to the session

Experimental. This type is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases.

Fields

agent_mode: Option<SendAgentMode>

The UI mode the agent was in when this message was sent. Defaults to the session’s current mode.

attachments: Option<Vec<Value>>

Optional attachments (files, directories, selections, blobs, GitHub references) to include with the message

billable: Option<bool>

If false, this message will not trigger a Premium Request Unit charge. User messages default to billable.

display_prompt: Option<String>

If provided, this is shown in the timeline instead of prompt

mode: Option<SendMode>

How to deliver the message. enqueue (default) appends to the message queue. immediate interjects during an in-progress turn.

prepend: Option<bool>

If true, adds the message to the front of the queue instead of the end

prompt: String

The user message text

request_headers: Option<HashMap<String, String>>

Custom HTTP headers to include in outbound model requests for this turn. Merged with session-level provider headers; per-turn headers augment and overwrite session-level headers with the same key.

required_tool: Option<String>

If set, the request will fail if the named tool is not available when this message is among the user messages at the start of the current exchange

traceparent: Option<String>

W3C Trace Context traceparent header for distributed tracing of this agent turn

tracestate: Option<String>

W3C Trace Context tracestate header for distributed tracing

wait: Option<bool>

If true, await completion of the agentic loop for this message before returning. Defaults to false (fire-and-forget). When true, the result still contains the same messageId; the caller can rely on the agent having processed the message before the call resolves.

Trait Implementations

impl Clone for SendRequest

fn clone(&self) -> SendRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SendRequest

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

Formats the value using the given formatter.

impl Default for SendRequest

fn default() -> SendRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SendRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SendRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.