Struct AgentBase 

pub struct AgentBase {
    pub upstream: Upstream,
    pub model: String,
    pub output_mode: OutputMode,
    pub effort: Option<Effort>,
    pub web_search_enabled: Option<bool>,
    pub prefix_content: Option<RichContent>,
    pub suffix_content: Option<RichContent>,
    pub mcp_servers: Option<McpServers>,
    pub client_objectiveai_mcp: Option<ClientObjectiveaiMcp>,
}

The base configuration for a Codex SDK Agent (without computed ID).

Fields

upstream: Upstream

The upstream provider marker.

model: String

The upstream language model identifier (e.g. gpt-5).

output_mode: OutputMode

The output mode for vector completions. Ignored for agent completions.

effort: Option<Effort>

Reasoning effort — maps to Codex’s model_reasoning_effort.

web_search_enabled: Option<bool>

Whether this agent may use the codex binary’s web-search tool.

prefix_content: Option<RichContent>

Rich content prepended to the user’s prompt.

suffix_content: Option<RichContent>

Rich content appended after the user’s prompt.

mcp_servers: Option<McpServers>

MCP servers the agent can connect to.

client_objectiveai_mcp: Option<ClientObjectiveaiMcp>

Client-side ObjectiveAI MCP surface the calling client is expected to expose locally back to the API (objectiveai built-in, plus specific plugins / tools by owner+name+version).

Implementations

impl AgentBase

pub fn prepare(&mut self)

Normalizes the configuration for deterministic ID computation.

pub fn validate(&self) -> Result<(), String>

Validates the configuration.

pub fn merged_messages(&self, messages: Vec<Message>) -> Vec<Message>

Returns prefix content (if set) as a user message, then the provided messages, then suffix content (if set) as a user message. Codex has no native system role; system-prompt-style instructions belong on the user message itself or in the calling layer’s input rendering.

pub fn id(&self) -> String

Computes the deterministic content-addressed ID.

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for AgentBase

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for AgentBase

fn clone(&self) -> AgentBase

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AgentBase

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

Formats the value using the given formatter.

impl Default for AgentBase

fn default() -> AgentBase

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AgentBase

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for AgentBase

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

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 inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for AgentBase

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for AgentBase

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 AgentBase

impl TryFrom<AgentBase> for Agent

type Error = String

The type returned in the event of a conversion error.

fn try_from(base: AgentBase) -> Result<Self, Self::Error>

Performs the conversion.