Struct ResponseCreateRequest 

pub struct ResponseCreateRequest {

    pub model: String,
    pub input: Option<ResponseInput>,
    pub instructions: Option<String>,
    pub tools: Option<Vec<ResponseTool>>,
    pub tool_choice: Option<ResponseToolChoice>,
    pub parallel_tool_calls: Option<bool>,
    pub previous_response_id: Option<String>,
    pub temperature: Option<f64>,
    pub top_p: Option<f64>,
    pub max_output_tokens: Option<i64>,
    pub truncation: Option<String>,
    pub reasoning: Option<Reasoning>,
    pub store: Option<bool>,
    pub metadata: Option<HashMap<String, String>>,
    pub include: Option<Vec<String>>,
    pub stream: Option<bool>,
    pub service_tier: Option<String>,
    pub user: Option<String>,
    pub text: Option<ResponseTextConfig>,
    pub prompt_cache_key: Option<String>,
    pub prompt_cache_retention: Option<String>,
    pub background: Option<bool>,
}

Request body for POST /responses.

Fields

model: String

Model to use.

input: Option<ResponseInput>

Input text or messages.

instructions: Option<String>

System instructions.

tools: Option<Vec<ResponseTool>>

Tools available to the model.

tool_choice: Option<ResponseToolChoice>

How the model selects tools.

parallel_tool_calls: Option<bool>

Whether to enable parallel tool calls.

previous_response_id: Option<String>

Previous response ID for multi-turn.

temperature: Option<f64>

Temperature (0-2).

top_p: Option<f64>

Nucleus sampling parameter.

max_output_tokens: Option<i64>

Max output tokens.

truncation: Option<String>

Truncation strategy: “auto” or “disabled”.

reasoning: Option<Reasoning>

Reasoning configuration for o-series models.

store: Option<bool>

Store for evals/distillation.

metadata: Option<HashMap<String, String>>

Metadata key-value pairs.

include: Option<Vec<String>>

Additional data to include in response.

stream: Option<bool>

Whether to stream.

service_tier: Option<String>

Service tier.

user: Option<String>

End user identifier.

text: Option<ResponseTextConfig>

Text output configuration.

prompt_cache_key: Option<String>

Prompt cache key — caches system prompt prefix server-side for faster repeat calls.

prompt_cache_retention: Option<String>

Prompt cache retention: “in-memory” or “24h” for extended caching.

background: Option<bool>

Whether to run in background mode.

Implementations

impl ResponseCreateRequest

pub fn new(model: impl Into<String>) -> Self

Create a new request with the given model.

pub fn input(self, input: impl Into<ResponseInput>) -> Self

Set the input text or messages.

pub fn instructions(self, instructions: impl Into<String>) -> Self

Set system instructions.

pub fn tools(self, tools: Vec<ResponseTool>) -> Self

Set the tools.

pub fn tool_choice(self, choice: ResponseToolChoice) -> Self

Set how the model selects tools.

pub fn previous_response_id(self, id: impl Into<String>) -> Self

Set previous response ID for multi-turn.

pub fn temperature(self, temperature: f64) -> Self

Set the temperature (0-2).

pub fn max_output_tokens(self, max: i64) -> Self

Set max output tokens.

pub fn reasoning(self, reasoning: Reasoning) -> Self

Set reasoning configuration.

pub fn truncation(self, truncation: impl Into<String>) -> Self

Set truncation strategy.

pub fn store(self, store: bool) -> Self

Enable storage for evals/distillation.

pub fn model(self, model: impl Into<String>) -> Self

Set model.

pub fn text(self, text: ResponseTextConfig) -> Self

Set text output configuration (format + verbosity).

pub fn top_p(self, top_p: f64) -> Self

Set top_p (nucleus sampling).

pub fn parallel_tool_calls(self, parallel: bool) -> Self

Enable or disable parallel tool calls.

pub fn metadata(self, metadata: HashMap<String, String>) -> Self

Set metadata key-value pairs.

pub fn include(self, include: Vec<String>) -> Self

Set include fields for additional response data.

pub fn service_tier(self, tier: impl Into<String>) -> Self

Set service tier (“auto”, “default”, “flex”, “scale”, “priority”).

pub fn user(self, user: impl Into<String>) -> Self

Set end user identifier.

pub fn prompt_cache_key(self, key: impl Into<String>) -> Self

Set prompt cache key for server-side system prompt caching.

pub fn prompt_cache_retention(self, retention: impl Into<String>) -> Self

Set prompt cache retention: “in-memory” or “24h”.

pub fn background(self, background: bool) -> Self

Run response in background mode.

Trait Implementations

impl Clone for ResponseCreateRequest

fn clone(&self) -> ResponseCreateRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResponseCreateRequest

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

Formats the value using the given formatter.

impl Default for ResponseCreateRequest

fn default() -> ResponseCreateRequest

Returns the “default value” for a type.

impl Serialize for ResponseCreateRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.