Responses
https://ai-gateway.lolipop.jp/v1/responsesテキストや会話の入力から、モデルの応答を生成します。
認証
Authorizationstring必須Bearer <APIキー> の形式で指定します。
詳しくは認証を参照してください。
リクエストボディ
モデルが対応していないパラメーターを指定すると、無視されるか 400 が返ります。
この一覧にないフィールドは無視されます。
api_key、base_url、fallbacks、timeout、metadata など、接続先や再試行に関するフィールドを指定すると、400 が返ります。
inputstring | array必須モデルへの入力。 文字列、または次のアイテムの配列を指定します。
フィールドを表示フィールドを非表示
messageobject会話のメッセージ。
role(user、assistant、system、developer)と content を指定します。
content は文字列、または input_text、input_image などのコンテンツパートの配列です。
function_callobjectモデルが要求したツールの呼び出し。
call_id、name、arguments を指定します。
function_call_outputobjectツールの実行結果。
call_id と output を指定します。
compaction_triggerobjectそれまでの会話の要約を要求するアイテム。
応答の output は、type が compaction のアイテム1つになります。
compactionobjectcompaction_trigger への応答で受け取ったアイテム。
そのまま送り返すと、要約が会話の先頭に復元されます。
instructionsstringモデルへの指示。
max_output_tokensintegerデフォルト値 4096生成するトークン数の上限。思考トークンを含みます。 1以上の整数で指定します。
parallel_tool_callsboolean1回の応答で複数のツール呼び出しを許可するかどうか。
prompt_cache_keystring同じキャッシュを使うリクエストに、共通で指定するキー。 対応するモデルはプロンプトキャッシュを参照してください。
reasoningobject思考の設定。
{ "effort": "low" } のように指定します。
思考に対応するモデルで指定できます。
service_tierstringデフォルト値 standard処理の優先度。
standard、default、standard_only、flex、priority を指定できます。
default と standard_only は standard として処理されます。
streambooleanデフォルト値 false応答を、生成された部分から順に返すかどうか。 形式はストリーミングを参照してください。
temperaturenumber出力のランダム性。 値が大きいほど多様な応答になります。
textobject出力の形式と詳しさの設定。
format、verbosity を指定します。
tool_choicestring | objectツールを呼び出すかどうか、どのツールを呼び出すかの指定。
auto、none、required、または呼び出す関数を指定します。
toolsarrayモデルが呼び出せるツールの一覧。
top_pnumber候補とするトークンの累積確率の上限。
truncationstring入力がコンテキスト長を超えた場合の動作。
auto または disabled を指定します。
userstringあなたのアプリケーションの利用者を区別するための識別子。
レスポンス
idstring応答のID。
objectstringオブジェクトの種類。
常に response です。
created_atinteger応答が作成された日時(UNIX時間、秒)。
statusstring応答の状態。
completed、incomplete などの値をとります。
modelstring応答を生成したモデルのID。
指定したモデルが応答できず、別のモデルが応答した場合(フォールバック)は、リクエストの model と異なります。
outputarrayモデルが生成したアイテムの配列。
各アイテムの type は次のいずれかです。
フィールドを表示フィールドを非表示
messageobjectモデルが生成したメッセージ。
content の各要素の text に本文が入ります。
function_callobjectモデルが要求したツールの呼び出し。
call_id、name、arguments を含みます。
reasoningobjectモデルの思考。
usageobjectトークンの使用量。
フィールドを表示フィールドを非表示
input_tokensinteger入力のトークン数。
output_tokensinteger出力のトークン数。
total_tokensinteger入力と出力のトークン数の合計。
エラー
エラーの一覧はエラーを参照してください。
| ステータスコード | code | 原因 |
|---|---|---|
400 | bad_request | リクエストボディの形式や値が正しくない |
400 | invalid_request | プロバイダーがリクエストを拒否した |
401 | invalid_api_key | APIキーが正しくない |
402 | insufficient_balance | クレジット残高が不足している |
402 | budget_guardrail_exceeded | 予算の上限を超えている |
403 | model_not_allowed | モデルの利用が許可されていない |
404 | model_not_found | モデルが見つからない |
429 | rate_limit_exceeded | レート制限を超えている |
502 | upstream_error | プロバイダーから正常なレスポンスを受け取れなかった |
503 | service_unavailable | サービスが一時的に利用できない |