responses

*[OpenAI Only]* Responses API: Create a streaming model response for the given input using server-sent events.

post/v1/responses#stream

Request

  • Base URL
    https://docs.sudoapp.dev (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Request body

backgroundboolean nullable
instructionsstring nullable
max_output_tokensinteger nullable
max_tool_callsinteger nullable
metadataunknown
modelstring nullable
parallel_tool_callsboolean nullable
previous_response_idstring nullable
promptunknown
prompt_cache_keystring nullable
reasoningunknown
safety_identifierstring nullable
service_tierstring nullable
storeboolean nullable
streamtrue

If set, partial message deltas and streaming events will be sent. For streaming responses, this must be set to true.

stream_optionsunknown
temperaturenumber float nullable
textunknown
top_logprobsinteger nullable
top_pnumber float nullable
truncationstring nullable

Response

Response stream created successfully

Changes

No recorded changes to this operation across all 1 revision of this API.