Chat Completions
https://ai-gateway.lolipop.jp/v1/chat/completions会話のメッセージから、モデルの応答を生成します。
認証
Authorizationstring必須Bearer <APIキー> の形式で指定します。
詳しくは認証を参照してください。
リクエストボディ
モデルが対応していないパラメーターを指定すると、無視されるか 400 が返ります。
この一覧にないフィールドは無視されます。
api_key、base_url、fallbacks、timeout、metadata など、接続先や再試行に関するフィールドを指定すると、400 が返ります。
messagesarray必須会話を構成するメッセージの配列。
各メッセージに role(system、user、assistant、tool)と content を指定します。
cache_control を付ける位置はプロンプトキャッシュを参照してください。
frequency_penaltynumber出現回数に応じて、トークンの繰り返しを抑えるペナルティ。
function_callstring | object非推奨tool_choice に置き換えられました。
functionsarray非推奨tools に置き換えられました。
logit_biasobjectトークンIDごとの出現しやすさの補正値。
logprobsboolean出力トークンの対数確率を返すかどうか。
max_completion_tokensinteger生成するトークン数の上限。思考トークンを含みます。
1以上の整数で指定します。
予算と残高の確認には、max_tokens とこの値のうち大きいほうを使います。
max_tokensintegerデフォルト値 4096生成するトークン数の上限。
1以上の整数で指定します。
max_tokens と max_completion_tokens をどちらも省略した場合は、4096 になります。
nintegerデフォルト値 1生成する応答の数。
1〜128の整数で指定します。
予算と残高の確認には、トークン数の上限に n を掛けた値を使います。
parallel_tool_callsboolean1回の応答で複数のツール呼び出しを許可するかどうか。
predictionobjectあらかじめ分かっている出力の内容。
presence_penaltynumberすでに出現したトークンの繰り返しを抑えるペナルティ。
prompt_cache_keystring同じキャッシュを使うリクエストに、共通で指定するキー。 対応するモデルはプロンプトキャッシュを参照してください。
reasoning_effortstring思考のレベル。 思考に対応するモデルで指定できます。
response_formatobject出力の形式。
{ "type": "json_object" } または { "type": "json_schema", ... } を指定します。
safety_identifierstring不正利用の検知に使う識別子。 OpenAIのモデルでは、組織ごとの値に置き換えて送信します。
seedinteger出力の再現性を高めるためのシード値。 同じ結果になることは保証されません。
service_tierstringデフォルト値 standard処理の優先度。
standard、default、standard_only、flex、priority を指定できます。
default と standard_only は standard として処理されます。
stopstring | string[]生成を終了させる文字列。
storeboolean応答をプロバイダーに保存するかどうか。
streambooleanデフォルト値 false応答を、生成された部分から順に返すかどうか。 形式はストリーミングを参照してください。
stream_optionsobjectストリーミングの設定。
{ "include_usage": true } を指定すると、最後のチャンクに使用量が含まれます。
temperaturenumber出力のランダム性。 値が大きいほど多様な応答になります。
tool_choicestring | objectツールを呼び出すかどうか、どのツールを呼び出すかの指定。
auto、none、required、または呼び出す関数を指定します。
toolsarrayモデルが呼び出せるツールの一覧。
top_logprobsinteger各位置で返す、確率が高いトークンの数。
logprobs が true の場合に指定できます。
top_pnumber候補とするトークンの累積確率の上限。
userstringあなたのアプリケーションの利用者を区別するための識別子。
verbositystring応答の詳しさ。
web_search_optionsobjectWeb検索の設定。 Web検索に対応するモデルで指定できます。
レスポンス
idstring応答のID。
objectstringオブジェクトの種類。
常に chat.completion です。
createdinteger応答が作成された日時(UNIX時間、秒)。
modelstring応答を生成したモデルのID。
指定したモデルが応答できず、別のモデルが応答した場合(フォールバック)は、リクエストの model と異なります。
choicesarray生成された応答の配列。
フィールドを表示フィールドを非表示
indexintegerchoices 内でのインデックス。
messageobjectモデルが生成したメッセージ。
フィールドを表示フィールドを非表示
rolestring常に assistant です。
contentstring | nullメッセージの本文。
tool_callsarrayモデルが要求したツールの呼び出し。
finish_reasonstring生成が終了した理由。
stop、length、tool_calls、content_filter などの値をとります。
usageobjectトークンの使用量。
フィールドを表示フィールドを非表示
prompt_tokensinteger入力のトークン数。
completion_tokensinteger出力のトークン数。
total_tokensinteger入力と出力のトークン数の合計。
provider_specific_fields、reasoning、reasoning_content、reasoning_details は含まれません。
エラー
エラーの一覧はエラーを参照してください。
| ステータスコード | 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 | サービスが一時的に利用できない |