POST /v1/responses

Method: POSTEndpoint: /v1/responses

https://platform.openai.com/docs/api-reference/responses/create

Some OpenAI models support only the Responses format, such as o3-pro and codex-mini-latest.

Request Parameters

Header Parameters

Authorization
string
Optional
Default Value:
Bearer {{YOUR_API_KEY}}

Body Parameters application/json

model
string
Required
stream
boolean
Required
input
array
[object]
Required
role
string
Optional
content
string
Optional
Example
{
"model"
:
"gpt-4.1"
,
"stream"
:
true
,
"input"
:
[
{
"role"
:
"user"
,
"content"
:
"Write a one-sentence bedtime story about a unicorn."
}
]
}

Example Request

Shell

curl --location --request POST '/v1/responses' \
--header 'Authorization: Bearer {{YOUR_API_KEY}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "model": "gpt-4.1",
    "stream": true,
    "input": [
        {
            "role": "user",
            "content": "Write a one-sentence bedtime story about a unicorn."
        }
    ]
  }'

Response

🟢 200 Success

Content Type: application/json

Response Schema

object

Example

event: response.created
data: {"type":"response.created","sequence_number":0,"response":{"id":"resp_68746e5933708190ab74346840b69f79035c53e470cb1bb3","object":"response","created_at":1752460889,"status":"in_progress","background":false,"error":null,"incomplete_details":null,"instructions":null,"max_output_tokens":null,"model":"gpt-4.1","output":[],"parallel_tool_calls":true,"previous_response_id":null,"reasoning":{"effort":null,"summary":null},"service_tier":"auto","store":true,"temperature":1.0,"text":{"format":{"type":"text"}},"tool_choice":"auto","tools":[],"top_p":1.0,"truncation":"disabled","usage":null,"user":null,"metadata":{}}}

event: response.in_progress
data: {"type":"response.in_progress","sequence_number":1,"response":{"id":"resp_68746e5933708190ab74346840b69f79035c53e470cb1bb3","object":"response","created_at":1752460889,"status":"in_progress","background":false,"error":null,"incomplete_details":null,"instructions":null,"max_output_tokens":null,"model":"gpt-4.1","output":[],"parallel_tool_calls":true,"previous_response_id":null,"reasoning":{"effort":null,"summary":null},"service_tier":"auto","store":true,"temperature":1.0,"text":{"format":{"type":"text"}},"tool_choice":"auto","tools":[],"top_p":1.0,"truncation":"disabled","usage":null,"user":null,"metadata":{}}}

event: response.output_item.added
data: {"type":"response.output_item.added","sequence_number":2,"output_index":0,"item":{"id":"msg_68746e59b95081909ec63a7ce0339f3e035c53e470cb1bb3","type":"message","status":"in_progress","content":[],"role":"assistant"}}

event: response.content_part.added
data: {"type":"response.content_part.added","sequence_number":3,"item_id":"msg_68746e59b95081909ec63a7ce0339f3e035c53e470cb1bb3","output_index":0,"content_index":0,"part":{"type":"output_text","annotations":[],"text":""}}

event: response.output_text.delta
data: {"type":"response.output_text.delta","sequence_number":4,"item_id":"msg_68746e59b95081909ec63a7ce0339f3e035c53e470cb1bb3","output_index":0,"content_index":0,"delta":"Under"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","sequence_number":5,"item_id":"msg_68746e59b95081909ec63a7ce0339f3e035c53e470cb1bb3","output_index":0,"content_index":0,"delta":" a"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","sequence_number":6,"item_id":"msg_68746e59b95081909ec63a7ce0339f3e035c53e470cb1bb3","output_index":0,"content_index":0,"delta":" moon"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","sequence_number":7,"item_id":"msg_68746e59b95081909ec63a7ce0339f3e035c53e470cb1bb3","output_index":0,"content_index":0,"delta":"lit"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","sequence_number":8,"item_id":"msg_68746e59b95081909ec63a7ce0339f3e035c53e470cb1bb3","output_index":0,"content_index":0,"delta":" sky"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","sequence_number":9,"item_id":"msg_68746e59b95081909ec63a7ce0339f3e035c53e470cb1bb3","output_index":0,"content_index":0,"delta":","}

event: response.output_text.delta
data: {"type":"response.output_text.delta","sequence_number":10,"item_id":"msg_68746e59b95081909ec63a7ce0339f3e035c53e470cb1bb3","output_index":0,"content_index":0,"delta":" a"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","sequence_number":11,"item_id":"msg_68746e59b95081909ec63a7ce0339f3e035c53e470cb1bb3","output_index":0,"content_index":0,"delta":" gentle"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","sequence_number":12,"item_id":"msg_68746e59b95081909ec63a7ce0339f3e035c53e470cb1bb3","output_index":0,"content_index":0,"delta":" unicorn"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","sequence_number":13,"item_id":"msg_68746e59b95081909ec63a7ce0339f3e035c53e470cb1bb3","output_index":0,"content_index":0,"delta":" tip"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","sequence_number":14,"item_id":"msg_68746e59b95081909ec63a7ce0339f3e035c53e470cb1bb3","output_index":0,"content_index":0,"delta":"to"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","sequence_number":15,"item_id":"msg_68746e59b95081909ec63a7ce0339f3e035c53e470cb1bb3","output_index":0,"content_index":0,"delta":"ed"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","sequence_number":16,"item_id":"msg_68746e59b95081909ec63a7ce0339f3e035c53e470cb1bb3","output_index":0,"content_index":0,"delta":" through"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","sequence_number":17,"item_id":"msg_68746e59b95081909ec63a7ce0339f3e035c53e470cb1bb3","output_index":0,"content_index":0,"delta":" a"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","sequence_number":18,"item_id":"msg_68746e59b95081909ec63a7ce0339f3e035c53e470cb1bb3","output_index":0,"content_index":0,"delta":" field"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","sequence_number":19,"item_id":"msg_68746e59b95081909ec63a7ce0339f3e035c53e470cb1bb3","output_index":0,"content_index":0,"delta":" of"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","sequence_number":20,"item_id":"msg_68746e59b95081909ec63a7ce0339f3e035c53e470cb1bb3","output_index":0,"content_index":0,"delta":" shimmering"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","sequence_number":21,"item_id":"msg_68746e59b95081909ec63a7ce0339f3e035c53e470cb1bb3","output_index":0,"content_index":0,"delta":" stars"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","sequence_number":22,"item_id":"msg_68746e59b95081909ec63a7ce0339f3e035c53e470cb1bb3","output_index":0,"content_index":0,"delta":","}

event: response.output_text.delta
data: {"type":"response.output_text.delta","sequence_number":23,"item_id":"msg_68746e59b95081909ec63a7ce0339f3e035c53e470cb1bb3","output_index":0,"content_index":0,"delta":" carrying"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","sequence_number":24,"item_id":"msg_68746e59b95081909ec63a7ce0339f3e035c53e470cb1bb3","output_index":0,"content_index":0,"delta":" sweet"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","sequence_number":25,"item_id":"msg_68746e59b95081909ec63a7ce0339f3e035c53e470cb1bb3","output_index":0,"content_index":0,"delta":" dreams"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","sequence_number":26,"item_id":"msg_68746e59b95081909ec63a7ce0339f3e035c53e470cb1bb3","output_index":0,"content_index":0,"delta":" to"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","sequence_number":27,"item_id":"msg_68746e59b95081909ec63a7ce0339f3e035c53e470cb1bb3","output_index":0,"content_index":0,"delta":" children"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","sequence_number":28,"item_id":"msg_68746e59b95081909ec63a7ce0339f3e035c53e470cb1bb3","output_index":0,"content_index":0,"delta":" as"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","sequence_number":29,"item_id":"msg_68746e59b95081909ec63a7ce0339f3e035c53e470cb1bb3","output_index":0,"content_index":0,"delta":" they"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","sequence_number":30,"item_id":"msg_68746e59b95081909ec63a7ce0339f3e035c53e470cb1bb3","output_index":0,"content_index":0,"delta":" slept"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","sequence_number":31,"item_id":"msg_68746e59b95081909ec63a7ce0339f3e035c53e470cb1bb3","output_index":0,"content_index":0,"delta":"."}

event: response.output_text.done
data: {"type":"response.output_text.done","sequence_number":32,"item_id":"msg_68746e59b95081909ec63a7ce0339f3e035c53e470cb1bb3","output_index":0,"content_index":0,"text":"Under a moonlit sky, a gentle unicorn tiptoed through a field of shimmering stars, carrying sweet dreams to children as they slept."}

event: response.content_part.done
data: {"type":"response.content_part.done","sequence_number":33,"item_id":"msg_68746e59b95081909ec63a7ce0339f3e035c53e470cb1bb3","output_index":0,"content_index":0,"part":{"type":"output_text","annotations":[],"text":"Under a moonlit sky, a gentle unicorn tiptoed through a field of shimmering stars, carrying sweet dreams to children as they slept."}}

event: response.output_item.done
data: {"type":"response.output_item.done","sequence_number":34,"output_index":0,"item":{"id":"msg_68746e59b95081909ec63a7ce0339f3e035c53e470cb1bb3","type":"message","status":"completed","content":[{"type":"output_text","annotations":[],"text":"Under a moonlit sky, a gentle unicorn tiptoed through a field of shimmering stars, carrying sweet dreams to children as they slept."}],"role":"assistant"}}

event: response.completed
data: {"type":"response.completed","sequence_number":35,"response":{"id":"resp_68746e5933708190ab74346840b69f79035c53e470cb1bb3","object":"response","created_at":1752460889,"status":"completed","background":false,"error":null,"incomplete_details":null,"instructions":null,"max_output_tokens":null,"model":"gpt-4.1","output":[{"id":"msg_68746e59b95081909ec63a7ce0339f3e035c53e470cb1bb3","type":"message","status":"completed","content":[{"type":"output_text","annotations":[],"text":"Under a moonlit sky, a gentle unicorn tiptoed through a field of shimmering stars, carrying sweet dreams to children as they slept."}],"role":"assistant"}],"parallel_tool_calls":true,"previous_response_id":null,"reasoning":{"effort":null,"summary":null},"service_tier":"default","store":true,"temperature":1.0,"text":{"format":{"type":"text"}},"tool_choice":"auto","tools":[],"top_p":1.0,"truncation":"disabled","usage":{"input_tokens":18,"input_tokens_details":{"cached_tokens":0},"output_tokens":29,"output_tokens_details":{"reasoning_tokens":0},"total_tokens":47},"user":null,"metadata":{}}}