Rivya Public API v1 で GPT-5.1 Codex を使うための model id gpt-5-1-codex-chat、対応入力、パラメータ、Files API ルール、クレジット、レスポンス例です。

API で利用可能テキスト入力対応チャット

API モデル ID

gpt-5-1-codex-chat

入力

text, file

Files API

最小リクエストでは不要

基本クレジット

機能

チャット

対応状況

Chat API: 非ストリーミング + SSE ストリーミング

課金

TOKEN_BASED

Prompt 上限

20000 文字

リクエスト仕様

Chat リクエストは一度に 1 つの message を送ります。session 履歴は Rivya が保存するため、raw messages array は送らないでください。

Key	型	必須	デフォルト	説明
model	string	はい	gpt-5-1-codex-chat	gpt-5-1-codex-chat を API モデル ID として使用します。
session_id	string	いいえ	-	API で作成されたチャットセッション ID。省略すると新しいセッションを開始します。
message	string	はい	-	次のユーザーメッセージです。Chat API の履歴は生の messages 配列ではなく、サーバー側セッションから取得されます。
attachments	array	いいえ	-	Files API が返す、必要に応じて指定する画像 file_id 値です。外部添付 URL は受け付けません。
enable_web_search	boolean	いいえ	false	選択した Chat モデルが Web 検索に対応している場合のみ適用されます。
reasoning_effort	string	いいえ	default	必要に応じて指定する reasoning effort: 対応している場合は default、minimal、low、medium、high、xhigh を指定できます。
client_request_id	string	いいえ	-	自社システム内でリクエストを追跡するための任意のクライアント側 ID です。

モデルパラメータ

この Chat モデルは上記の共通 Chat API フィールドを使います。Web 検索、画像 file 添付、thoughts、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 メッセージ、トークン使用量、このターンの最終クレジット精算を返します。

{
  "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 で non-streaming と SSE streaming のターンに対応しています。画像添付には Files API の file_id 値を使用する必要があります。

GPT-5.1 Codex API 連携