Skip to content

OpenAI Responses

兼容 OpenAI 官方 Responses API:POST /v1/responses。相比 Chat Completions,Responses 更适合多轮对话、工具调用、推理模型(o 系列)等场景,并支持响应链式延续。

WARNING

建议使用官方原生接口。Responses API 是 OpenAI 原生新接口,主要服务于 GPT / o 系列模型。若通过本接口调用非 OpenAI 模型(如 Claude、Gemini),由代理侧进行格式转换,可能存在参数缺失或行为差异等问题。具体支持范围请咨询 FreeAPI。

请求

Endpoint

http
POST https://www.free-api.ai/api/v1/responses

请求头

名称必填说明
AuthorizationBearer your-api-key
Content-Typeapplication/json

请求参数

字段类型必填说明
modelstring模型 ID
inputstring | array输入内容,可以是字符串或消息数组
instructionsstring系统指令(等价于 system message)
max_output_tokensinteger最大输出 Token 数
temperaturenumber采样温度
top_pnumber核采样参数
streamboolean是否流式响应
toolsarray可调用的工具列表
tool_choicestring | object工具选择策略
reasoningobject推理配置,例如 { "effort": "medium", "summary": "auto" }
previous_response_idstring上一轮响应 ID,用于延续对话
truncationstring截断策略,autodisabled

请求示例

cURL

bash
curl https://www.free-api.ai/api/v1/responses \
  -H "Authorization: Bearer your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5",
    "input": "帮我写一首关于秋天的短诗。",
    "instructions": "你是一个诗人,输出简洁而富有画面感的中文。",
    "reasoning": { "effort": "medium" }
  }'

多轮延续

bash
curl https://www.free-api.ai/api/v1/responses \
  -H "Authorization: Bearer your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5",
    "previous_response_id": "resp_xxxxxxxx",
    "input": "基于刚才的诗,再写一段散文。"
  }'

Python (OpenAI SDK)

python
from openai import OpenAI

client = OpenAI(
    api_key="your-api-key",
    base_url="https://www.free-api.ai/api/v1",
)

resp = client.responses.create(
    model="gpt-5",
    input="帮我写一首关于秋天的短诗。",
    instructions="你是一个诗人,输出简洁而富有画面感的中文。",
)
print(resp.output_text)

响应示例

非流式

json
{
  "id": "resp_xxxxxxxx",
  "object": "response",
  "created_at": 1730000000,
  "status": "completed",
  "model": "gpt-5",
  "output": [
    {
      "type": "message",
      "id": "msg_xxxxxxxx",
      "status": "completed",
      "role": "assistant",
      "content": [
        {
          "type": "output_text",
          "text": "落叶乘风入旧窗,一盏清茶半卷黄。"
        }
      ]
    }
  ],
  "usage": {
    "input_tokens": 32,
    "output_tokens": 18,
    "total_tokens": 50
  }
}

流式 (stream: true)

流式响应以 SSE 事件形式返回,每个事件包含 type 字段:

event: response.output_text.delta
data: {"type":"response.output_text.delta","delta":"落叶"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","delta":"乘风"}

event: response.completed
data: {"type":"response.completed","response":{ ... }}

状态字段

status 可能取值:

含义
completed响应已完成
in_progress处理中(仅在非阻塞/轮询场景出现)
incomplete响应被截断或中途终止
failed执行失败

常见错误

HTTP 状态说明
400请求参数错误
401鉴权失败
429请求频率限制
5xx上游服务异常

Made with docs by FreeAPI Team