通过 Rivya Public API v1 调用 GPT-5.1 Codex，包含模型 ID gpt-5-1-codex-chat、输入类型、参数、Files API 规则、积分和响应示例。

API 可调用文本输入可用对话

API 模型 ID

gpt-5-1-codex-chat

输入类型

text, file

Files API

最小请求不需要

基础积分

能力类型

对话

可用状态

Chat API：非 streaming + SSE streaming

计费方式

TOKEN_BASED

提示词上限

20000 字符

请求字段

Chat 请求一次发送一条 message。历史上下文由 Rivya session 保存，不接受 raw messages 数组。

Key	类型	必填	默认值	说明
model	string	是	gpt-5-1-codex-chat	使用 gpt-5-1-codex-chat 作为 API 模型 ID。
session_id	string	否	-	可选 API 创建的对话 session ID。省略时会创建新 session。
message	string	是	-	下一条用户消息。Chat API 的历史上下文来自服务端 session，不接受 raw messages 数组。
attachments	array	否	-	可选图片 file_id，必须来自 Files API。这里不接受外部附件 URL。
enable_web_search	boolean	否	false	仅在所选 Chat 模型支持联网搜索时生效。
reasoning_effort	string	否	default	可选推理强度：default、minimal、low、medium、high 或 xhigh，按模型支持情况生效。
client_request_id	string	否	-	可选客户端请求 ID，便于你在自己的系统中追踪请求。

模型参数

这个 Chat 模型使用上方通用 Chat API 字段。联网搜索、图片 file 附件、思考内容和 reasoning 支持情况会体现在 readiness 数据里。

最小请求

{
  "model": "gpt-5-1-codex-chat",
  "message": "Write a concise launch plan for a new product image campaign"
}

参考文件请求

{
  "model": "gpt-5-1-codex-chat",
  "message": "Write a concise launch plan for a new product image campaign",
  "attachments": [
    {
      "file_id": "file_uploaded_image_id"
    }
  ]
}

创建响应

Chat 接口会直接返回本轮 assistant message、token usage 和最终积分结算。

{
  "id": "chatcmpl_msg_gpt_5_1_codex_chat_example",
  "object": "chat.completion",
  "session_id": "chat_session_gpt_5_1_codex_chat",
  "model": "gpt-5-1-codex-chat",
  "created_at": "2026-05-11T00:00:00.000Z",
  "message": {
    "id": "assistant_message_id",
    "role": "assistant",
    "content": "A concise launch plan with clear next steps."
  },
  "usage": {
    "input_tokens": 1200,
    "output_tokens": 320,
    "total_tokens": 1520
  },
  "credits": {
    "reserved": 3,
    "final": 3
  }
}

常见错误

validation_failed, insufficient_credits, idempotency_conflict, rate_limited, not_found, chat_model_not_supported, chat_session_conflict, chat_attachment_not_supported

Chat API 在 Public API v1 中支持非 streaming 和 SSE streaming 回合。图片附件必须使用 Files API 返回的 file_id。

GPT-5.1 Codex API 接入文档