Struct TurnStartParams 

pub struct TurnStartParams {

    pub thread_id: String,
    pub client_user_message_id: Option<String>,
    pub input: Vec<UserInput>,
    pub responsesapi_client_metadata: Option<HashMap<String, String>>,
    pub additional_context: Option<HashMap<String, AdditionalContextEntry>>,
    pub environments: Option<Vec<TurnEnvironmentParams>>,
    pub cwd: Option<PathBuf>,
    pub runtime_workspace_roots: Option<Vec<AbsolutePathBuf>>,
    pub approval_policy: Option<AskForApproval>,
    pub approvals_reviewer: Option<ApprovalsReviewer>,
    pub sandbox_policy: Option<SandboxPolicy>,
    pub permissions: Option<String>,
    pub model: Option<String>,
    pub service_tier: Option<Option<String>>,
    pub effort: Option<ReasoningEffort>,
    pub summary: Option<ReasoningSummary>,
    pub personality: Option<Personality>,
    pub output_schema: Option<Value>,
    pub collaboration_mode: Option<CollaborationMode>,
    pub multi_agent_mode: Option<MultiAgentMode>,
}

Fields

thread_id: String

client_user_message_id: Option<String>

input: Vec<UserInput>

responsesapi_client_metadata: Option<HashMap<String, String>>

Optional metadata to enrich Codex’s ResponsesAPI turn metadata.

Entries are flattened into the JSON string sent as client_metadata["x-codex-turn-metadata"] on ResponsesAPI HTTP and websocket requests.

They are not sent as top-level ResponsesAPI client_metadata keys, and reserved keys such as session_id, thread_id, turn_id, and window_id cannot be overridden.

additional_context: Option<HashMap<String, AdditionalContextEntry>>

Optional client-provided context fragments keyed by an opaque source identifier.

environments: Option<Vec<TurnEnvironmentParams>>

Optional environments for this turn and subsequent turns.

Omitted uses the thread sticky environments. Empty disables environment access for this turn. Non-empty selects the first environment as the current turn environment for this turn.

cwd: Option<PathBuf>

Override the working directory for this turn and subsequent turns.

runtime_workspace_roots: Option<Vec<AbsolutePathBuf>>

Replace the thread’s runtime workspace roots for this turn and subsequent turns. Paths must be absolute.

approval_policy: Option<AskForApproval>

Override the approval policy for this turn and subsequent turns.

approvals_reviewer: Option<ApprovalsReviewer>

Override where approval requests are routed for review on this turn and subsequent turns.

sandbox_policy: Option<SandboxPolicy>

Override the sandbox policy for this turn and subsequent turns.

permissions: Option<String>

Select a named permissions profile id for this turn and subsequent turns. Cannot be combined with sandboxPolicy.

model: Option<String>

Override the model for this turn and subsequent turns.

service_tier: Option<Option<String>>

Override the service tier for this turn and subsequent turns.

effort: Option<ReasoningEffort>

Override the reasoning effort for this turn and subsequent turns.

summary: Option<ReasoningSummary>

Override the reasoning summary for this turn and subsequent turns.

personality: Option<Personality>

Override the personality for this turn and subsequent turns.

output_schema: Option<Value>

Optional JSON Schema used to constrain the final assistant message for this turn.

collaboration_mode: Option<CollaborationMode>

EXPERIMENTAL - Set a pre-set collaboration mode. Takes precedence over model, reasoning_effort, and developer instructions if set.

For collaboration_mode.settings.developer_instructions, null means “use the built-in instructions for the selected mode”.

multi_agent_mode: Option<MultiAgentMode>

@deprecated Ignored. Use effort: "ultra" for proactive multi-agent behavior.

Trait Implementations

impl Clone for TurnStartParams

fn clone(&self) -> TurnStartParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TurnStartParams

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

Formats the value using the given formatter.

impl Default for TurnStartParams

fn default() -> TurnStartParams

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TurnStartParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl ExperimentalApi for TurnStartParams

fn experimental_reason(&self) -> Option<&'static str>

Returns a short reason identifier when an experimental method or field is used, or None when the value is entirely stable.

impl JsonSchema for TurnStartParams

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for TurnStartParams

fn eq(&self, other: &TurnStartParams) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for TurnStartParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TurnStartParams

impl TS for TurnStartParams

type WithoutGenerics = TurnStartParams

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or (). The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = TurnStartParams

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident() -> String

Identifier of this type, excluding generic parameters.

fn name() -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete() -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl() -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline() -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened() -> String

Flatten a type declaration.
This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.
The returned path does not include the base directory from TS_RS_EXPORT_DIR.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn dependencies() -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_all_to(out_dir: impl AsRef<Path>) -> Result<(), ExportError>

where Self: 'static,

Manually export this type into the given directory, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_to_string() -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String.
This function does not format the output, even if the format feature is enabled.

fn default_output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.