pub struct TurnStartParams {
pub session_id: String,
pub command_id: String,
pub input: Vec<TurnInputPart>,
pub if_busy: Option<IfBusy>,
pub display_text: Option<String>,
pub reasoning_effort: Option<ReasoningEffort>,
pub token_budget: Option<u64>,
pub workspace_roots: Option<Vec<String>>,
pub user_shell: Option<TurnUserShell>,
}Expand description
turn/start params.
turn/start.providerRequestOptions is deliberately absent: RULED to stay
off the published schema. The schema is the contract, and a
free-form-object node kind is revisited only if the experimental field
graduates.
Fields§
§session_id: StringThe target session.
command_id: StringThe idempotency handle (UUIDv7). The fresh turn’s turnId derives from
it.
input: Vec<TurnInputPart>Ordered content parts; required and non-empty.
if_busy: Option<IfBusy>Disposition when a turn is already running; default queue.
display_text: Option<String>Presentation form of the prompt for transcripts. Durable; carried on the resulting user-message view item. Never model-visible.
reasoning_effort: Option<ReasoningEffort>Reasoning tier sampled at submission for this turn.
token_budget: Option<u64>This turn’s token budget in tokens: an integer floor of 1, riding to
workflow-launch admission and inert when no workflow launches. Omitted
means no budget; 0 or a non-integer is invalid params, as is explicit
null. No wire upper bound beyond the integer type. Experimental: only
the name and shape are settled, not v1 membership, so the member ships
off the stable bundle until it graduates.
workspace_roots: Option<Vec<String>>A sticky REPLACEMENT of the session’s runtime workspace-root set,
binding at this turn’s launch and persisting for subsequent turns until
replaced again — unlike reasoningEffort, which is this-turn-only. Same
shape and validation as session/start.workspaceRoots; invalid params
on an explicit ifBusy: "steer" submit and so is explicit null;
omitted means “unchanged”, never “reset”.
user_shell: Option<TurnUserShell>A queued ! shell action riding this turn: the !cmd typed while a
turn runs, executed at the next model-call boundary before any later
steer. Exclusive with text and skill input; input may be empty
only when this member is present. Capability-gated on userShell: a
carrying turn on a connection without the grant fails -32010 capabilityRequired. Explicit null is invalid params (the
null-tolerant set is closed). A v1 stable member.