OpenAI Responses

Request

Body Params application/json

Example

{
  "model": "gpt-5",
  "tools": [
    {
      "type": "web_search"
    }
  ],
  "input": "what was a positive news story from today?"
}

Request Code Samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/v1/responses' \
--header 'Content-Type: application/json' \
--data-raw '{
  "model": "gpt-5",
  "tools": [
    {
      "type": "web_search"
    }
  ],
  "input": "what was a positive news story from today?"
}'

Responses

🟢200OK

application/json

Body

Example

{
    "id": "resp_044e98bc590bf3c40068c95b2c42bc819687b10bcb6c7bb18f",
    "object": "response",
    "created_at": 1758026540,
    "status": "completed",
    "background": false,
    "error": null,
    "incomplete_details": null,
    "instructions": null,
    "max_output_tokens": null,
    "max_tool_calls": null,
    "model": "gpt-4.1-mini-2025-04-14",
    "output": [
        {
            "id": "ws_044e98bc590bf3c40068c95b2d7c5481968724df59ec013404",
            "type": "web_search_call",
            "status": "completed",
            "action": {
                "type": "search",
                "query": "positive news stories April 27, 2024"
            }
        },
        {
            "id": "msg_044e98bc590bf3c40068c95b2ee88c8196926752964d797785",
            "type": "message",
            "status": "completed",
            "content": [
                {
                    "type": "output_text",
                    "annotations": [
                        {
                            "type": "url_citation",
                            "end_index": 710,
                            "start_index": 565,
                            "title": "GNR for Tuesday, September 16, 2025 — More and more good news!",
                            "url": "https://www.dailykos.com/stories/2025/9/16/2342576/-GNR-for-Tuesday-September-16-2025-More-and-more-good-news?utm_source=openai"
                        }
                    ],
                    "logprobs": [],
                    "text": "On September 16, 2025, a notable positive news story emerged from Singapore, where the city-state announced plans to construct an 86-megawatt floating solar farm atop its largest reservoir, Pandan Reservoir. This innovative project aims to generate 296 megawatts of clean energy, contributing significantly to Singapore's efforts in decarbonizing its urban environment. The floating solar farm will be developed by Sembcorp Solar Singapore, marking the third such installation on Singapore's reservoirs, following previous projects on Tengeh and Kranji reservoirs. ([dailykos.com](https://www.dailykos.com/stories/2025/9/16/2342576/-GNR-for-Tuesday-September-16-2025-More-and-more-good-news?utm_source=openai))\n\nThis initiative reflects Singapore's commitment to sustainable energy solutions, particularly in urban settings where space is limited. By utilizing its reservoirs for solar energy production, Singapore not only maximizes land use but also advances its goals for renewable energy adoption. "
                }
            ],
            "role": "assistant"
        }
    ],
    "parallel_tool_calls": true,
    "previous_response_id": null,
    "prompt_cache_key": null,
    "reasoning": {
        "effort": null,
        "summary": null
    },
    "safety_identifier": null,
    "service_tier": "default",
    "store": true,
    "temperature": 1.0,
    "text": {
        "format": {
            "type": "text"
        },
        "verbosity": "medium"
    },
    "tool_choice": "auto",
    "tools": [
        {
            "type": "web_search",
            "filters": null,
            "search_context_size": "medium",
            "user_location": {
                "type": "approximate",
                "city": null,
                "country": "US",
                "region": null,
                "timezone": null
            }
        }
    ],
    "top_logprobs": 0,
    "top_p": 1.0,
    "truncation": "disabled",
    "usage": {
        "input_tokens": 8484,
        "input_tokens_details": {
            "cached_tokens": 0
        },
        "output_tokens": 229,
        "output_tokens_details": {
            "reasoning_tokens": 0
        },
        "total_tokens": 8713
    },
    "user": null,
    "metadata": {}
}