SUsudoapp
responses

*[OpenAI Only]* Responses API: Create a model response for the given input

post/v1/responses

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
streamfalse

If set, partial message deltas and streaming events will be sent. For regular HTTP responses, this must be false.

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

Response

Response created successfully

backgroundboolean nullable

Whether the response was generated in the background

created_atinteger required

Unix timestamp (in seconds) when the response was created

errorunknown
idstring required

Unique identifier for the response

max_output_tokensinteger nullable

Maximum number of output tokens

max_tool_callsinteger nullable

Maximum number of tool calls

metadataunknown
modelstring required

The model used to generate the response

objectstring required

The object type, always "response"

parallel_tool_callsboolean nullable

Whether parallel tool calls are enabled

previous_response_idstring nullable

ID of the previous response

promptunknown
prompt_cache_keystring nullable

Prompt cache key

reasoningunknown
safety_identifierstring nullable

Safety identifier

service_tierstring nullable

Service tier used

statusstring required

The status of the response (e.g., "in_progress", "completed", "failed", "cancelled", "incomplete")

temperaturenumber float nullable

Temperature sampling parameter

textunknown
top_logprobsinteger nullable

Number of top log probabilities to return

top_pnumber float nullable

Top-p sampling parameter

truncationstring nullable

Truncation strategy

Changes

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