Skip to main content
POST
OpenAI Responses APIフォーマットを使用して、ストリーミングまたは非ストリーミングのレスポンスを作成します。

認証

string
必須
Bearerトークン。APIキーをAuthorizationヘッダーのBearerトークンとして使用してください。Format: Bearer <SUNRA_KEY>

リクエスト

このエンドポイントはJSONオブジェクトを受け付けます。
string
必須
レスポンス生成に使用するモデルID。利用可能なモデルは sunra.ai/models で確認できます。
string | object[]
レスポンスリクエストの入力。文字列または入力アイテムの配列を指定できます。
string | null
モデルのコンテキストの最初のアイテムとしてシステム(または開発者)メッセージを挿入します。inputと共に使用する場合、instructionsは入力の先頭に挿入されます。
boolean
デフォルト:false
trueに設定すると、サーバー送信イベント(SSE)を使用してレスポンスがストリーミングされます。
integer
可視出力トークンと推論トークンを含む、出力トークン数の上限。
number
デフォルト:1
0から2の間のサンプリング温度。値が高いほどランダム性が増加します。
number
デフォルト:1
核サンプリングパラメータ。temperatureによるサンプリングの代替です。
number
デフォルト:0
-2.0から2.0の間の数値。正の値は、テキスト中の既存の頻度に基づいて新しいトークンにペナルティを課します。
number
デフォルト:0
-2.0から2.0の間の数値。正の値は、テキスト中に既に出現しているかどうかに基づいて新しいトークンにペナルティを課します。
object[]
モデルが呼び出す可能性のあるツールの配列。
string | object
ツール選択の動作を制御します。サポートされている文字列値: none, auto, required。特定の関数を指定することもできます。
boolean
デフォルト:true
モデルがツール呼び出しを並列に実行することを許可するかどうか。
object
テキストレスポンスフォーマットの設定。
object
推論出力の設定。
boolean
デフォルト:true
生成されたレスポンスを後で取得するために保存するかどうか。
object
レスポンスに添付できる16個のキーと値のペアのセット。キーは最大64文字の文字列です。値は最大512文字の文字列です。
string
エンドユーザーを表す一意の識別子。最大128文字。

レスポンス

成功レスポンスオブジェクト。
string
一意のレスポンス識別子。
string
オブジェクトタイプ。常にresponse
number
レスポンスが作成された時のUnixタイムスタンプ(秒単位)。
string
レスポンスのステータス。可能な値: completed, failed, in_progress, cancelled
string
レスポンス生成に使用されたモデル。
object[]
モデルによって生成されたコンテンツアイテムの配列。
object
レスポンスのトークン使用統計。
number
使用されたサンプリング温度。
number
使用された核サンプリング値。
integer | null
使用された最大出力トークン設定。
object | null
生成が失敗した場合のエラーオブジェクト。