Skip to main content
POST
Create Response (OpenAI)
Create a model response from text or message input.

Create Response

POST /responses Create a text response using OpenAI’s response format.

Request Body

string
required
The model to use for response (e.g., “gpt-4o”)
string | array
required
The input text or array of messages to generate responses for
string
System instructions for the model
integer
Maximum number of output tokens to generate
number
Temperature for randomness (default: 1.0)
number
Nucleus sampling parameter (default: 1.0)
boolean
Whether to stream back partial progress (default: false)
array
Array of tools available to the model
string | object
Tool choice preference (“auto”, “none”, or specific tool object)
Enable web search capabilities (default: false)
object
Reasoning configuration with effort level and summary options
object
Additional metadata as key-value pairs

Response

Returns a response object with the generated text.

Example

Authorizations

Authorization
string
header
required

Enter your API key (starts with 'ek-')

Body

application/json
model
string
required
Example:

"gpt-4o"

input
required
instructions
string

System instructions

max_output_tokens
integer

Maximum output tokens

temperature
number
default:1
top_p
number
default:1
stream
boolean
default:false
tools
object[]
tool_choice
default:auto
Available options:
auto,
none
reasoning
object
metadata
object

Response

200 - application/json

Success

id
string
required
object
enum<string>
required
Available options:
response
created_at
integer
required
status
enum<string>
required
Available options:
in_progress,
completed,
incomplete,
errored
model
string
required
output
object[]
required
usage
object