responses

Create a model response (Responses API)

Changed on
post/v1/responses

Request

  • Base URL
    http://localhost:8080
  • URL
    http://localhost:8080/v1/responses
  • Auth
    HTTP bearer

Request body

context_managementunknown
includestring[]
instructionsstring
max_output_tokensinteger
metadataobject
modelstring
parallel_tool_callsboolean
previous_response_idstring
promptunknown
prompt_cache_retentionstring
providerstring

Gateway routing hint; stripped before upstream execution.

safety_identifierstring
service_tierstring
storeboolean
streamboolean
temperaturenumber
textunknown
tool_choiceunknown
toolsobject[]
top_logprobsinteger
top_pnumber
truncationstring
userstring

Response

JSON response or SSE stream when stream=true

created_atinteger
idstring
modelstring
objectstring

"response"

previous_response_idstring

PreviousResponseID names the response this one was chained from, as OpenAI echoes it; stored snapshots follow it to rebuild the history.

providerstring
statusstring

"completed", "incomplete", "failed", "in_progress"

Changes

    • info

      added the optional property //// to the response with the status (media type: application/json)

    • info

      added the optional property //// to the response with the status (media type: text/event-stream)

    • info

      added the optional property // to the response with the status (media type: application/json)

    • info

      added the optional property // to the response with the status (media type: text/event-stream)