codex模型请求 - 聚合API接口文档

请求参数

Header 参数

Body 参数application/json

示例

{
    "model": "gpt-5.1-codex-max",
    "input": [
        {
            "role": "user",
            "content": [
                {
                    "type": "input_text",
                    "text": "一只啄木鸟能啄多少木头?"
                }
            ]
        }
    ],
    "reasoning": {
        "effort": "low",
        "generate_summary": "detailed",
        "summary": "detailed"
    }
}

请求示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location -g --request POST 'http://api.example.com/v1/responses' \
--header 'Authorization: Bearer sk-xxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "model": "gpt-5.1-codex-max",
    "input": [
        {
            "role": "user",
            "content": [
                {
                    "type": "input_text",
                    "text": "一只啄木鸟能啄多少木头?"
                }
            ]
        }
    ],
    "reasoning": {
        "effort": "low",
        "generate_summary": "detailed",
        "summary": "detailed"
    }
}'

返回响应

🟢200成功

application/json

Body

示例

{
    "background": false,
    "created_at": 1764053302,
    "error": null,
    "id": "resp_0453e582eae223e5016925513605788195b207cd12e5b04437",
    "incomplete_details": null,
    "max_output_tokens": null,
    "max_tool_calls": null,
    "metadata": {},
    "model": "gpt-5.1-codex-medium",
    "object": "response",
    "output": [
        {
            "id": "rs_0453e582eae223e501692551363980819591508e8e4a7b04e0",
            "summary": [
                {
                    "text": "**Preparing a language-aware reply**",
                    "type": "summary_text"
                }
            ],
            "type": "reasoning"
        },
        {
            "content": [
                {
                    "annotations": [],
                    "logprobs": [],
                    "text": "那句绕口令原本是 “How much wood would a woodchuck chuck if a woodchuck could chuck wood?” 按照原版的玩笑公式，答案是 “A woodchuck would chuck all the wood it could chuck if a woodchuck could chuck wood.” 换成中文，大意就是：“如果啄木鸟能啄木头，它会把自己能啄的木头都啄掉。”",
                    "type": "output_text"
                }
            ],
            "id": "msg_0453e582eae223e501692551370ecc8195a1c117ad80d6bd49",
            "role": "assistant",
            "status": "completed",
            "type": "message"
        }
    ],
    "parallel_tool_calls": true,
    "previous_response_id": null,
    "prompt_cache_key": "e9c7afb2-561a-40a1-a14f-5047960e7691",
    "prompt_cache_retention": null,
    "reasoning": {
        "effort": "medium",
        "summary": "detailed"
    },
    "safety_identifier": "user-up587t56JsaWRn24EDiPpNl7",
    "service_tier": "default",
    "status": "completed",
    "store": false,
    "temperature": 1,
    "text": {
        "format": {
            "type": "text"
        },
        "verbosity": "medium"
    },
    "tool_choice": "auto",
    "tools": [],
    "top_logprobs": 0,
    "top_p": 1,
    "truncation": "disabled",
    "usage": {
        "input_tokens": 2111,
        "input_tokens_details": {
            "cached_tokens": 0
        },
        "output_tokens": 100,
        "output_tokens_details": {
            "reasoning_tokens": 0
        },
        "total_tokens": 2211
    },
    "user": null
}