Query Parameters

• include: optional array of ResponseIncludable

  Additional fields to include in the response. See the include parameter for Response creation above for more information.

  • "file_search_call.results"

  • "web_search_call.results"

  • "web_search_call.action.sources"

  • "message.input_image.image_url"

  • "computer_call_output.output.image_url"

  • "code_interpreter_call.outputs"

  • "reasoning.encrypted_content"

  • "message.output_text.logprobs"

• include_obfuscation: optional boolean

  When true, stream obfuscation will be enabled. Stream obfuscation adds random characters to an obfuscation field on streaming delta events to normalize payload sizes as a mitigation to certain side-channel attacks. These obfuscation fields are included by default, but add a small amount of overhead to the data stream. You can set include_obfuscation to false to optimize for bandwidth if you trust the network links between your application and the OpenAI API.

• starting_after: optional number

  The sequence number of the event after which to start streaming.

• stream: optional false

  If set to true, the model response data will be streamed to the client as it is generated using server-sent events. See the Streaming section below for more information.

  • false