Struct PtyShellCreateRequest 

pub struct PtyShellCreateRequest {
    pub agent_block_id: String,
    pub cwd: Option<String>,
    pub rows: Option<u16>,
    pub cols: Option<u16>,
    pub connection: Option<String>,
    pub auth: Option<UiAutomationAuth>,
}

POST /api/v1/ptyshell/create

Fields

agent_block_id: String

cwd: Option<String>

rows: Option<u16>

cols: Option<u16>

connection: Option<String>

Where the shell runs: local (the default) or wsl://<distro>. An SSH destination is refused until SSH terminals ship (SPEC_REMOTE_TERMINALS_AND_DURABLE_SESSIONS_2026_10_02.md §8).

auth: Option<UiAutomationAuth>

The calling agent’s signed identity (UiAutomationAuth, its own jekt key). Required for an SSH connection: srv derives the agent’s pane from it and refuses a request naming another pane, so no agent can borrow another’s SSH consent.

Trait Implementations

impl Clone for PtyShellCreateRequest

fn clone(&self) -> PtyShellCreateRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PtyShellCreateRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PtyShellCreateRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PtyShellCreateRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.