Skip to Content
APIリファレンステキストChat Completions

Chat Completions

POSThttps://ai-gateway.lolipop.jp/v1/chat/completions

会話のメッセージから、モデルの応答を生成します。

認証

Authorizationstring必須

Bearer <APIキー> の形式で指定します。 詳しくは認証を参照してください。

リクエストボディ

モデルが対応していないパラメーターを指定すると、無視されるか 400 が返ります。 この一覧にないフィールドは無視されます。 api_key、base_url、fallbacks、timeout、metadata など、接続先や再試行に関するフィールドを指定すると、400 が返ります。

modelstring必須

使用するモデルのID。 モデルの一覧で取得できます。 auto を指定した場合の動作はモデルの自動選択を参照してください。

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_callsboolean

1回の応答で複数のツール呼び出しを許可するかどうか。

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_optionsobject

Web検索の設定。 Web検索に対応するモデルで指定できます。

レスポンス

idstring

応答のID。

objectstring

オブジェクトの種類。 常に chat.completion です。

createdinteger

応答が作成された日時(UNIX時間、秒)。

modelstring

応答を生成したモデルのID。 指定したモデルが応答できず、別のモデルが応答した場合(フォールバック)は、リクエストの model と異なります。

choicesarray

生成された応答の配列。

フィールドを表示フィールドを非表示
indexinteger

choices 内でのインデックス。

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原因
400bad_requestリクエストボディの形式や値が正しくない
400invalid_requestプロバイダーがリクエストを拒否した
401invalid_api_keyAPIキーが正しくない
402insufficient_balanceクレジット残高が不足している
402budget_guardrail_exceeded予算の上限を超えている
403model_not_allowedモデルの利用が許可されていない
404model_not_foundモデルが見つからない
429rate_limit_exceededレート制限を超えている
502upstream_errorプロバイダーから正常なレスポンスを受け取れなかった
503service_unavailableサービスが一時的に利用できない