Skip to Content

Messages

POSThttps://ai-gateway.lolipop.jp/v1/messages

会話のメッセージから、モデルの応答を生成します。 POST /anthropic/v1/messages でも同じように利用できます。

認証

Authorizationstring必須

Bearer <APIキー> の形式で指定します。 Anthropic SDKと同じ x-api-key ヘッダーでも指定できます。 詳しくは認証を参照してください。

リクエストボディ

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

modelstring必須

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

messagesarray必須

会話を構成するメッセージの配列。

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

メッセージのロール。 user または assistant を指定します。

contentstring | array

メッセージの本文。 文字列、または要素(コンテンツブロック)の配列を指定します。 各要素の type は次のいずれかです。 これ以外のブロックは指定できません(400)。 cache_control を付ける位置はプロンプトキャッシュを参照してください。

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

テキスト。

imageobject

画像。 source.type には base64 を指定します。

tool_useobject

モデルが要求したツールの呼び出し。

tool_resultobject

ツールの実行結果。

thinkingobject

モデルの思考の内容。

max_tokensintegerデフォルト値 4096

生成するトークン数の上限。 1以上の整数で指定します。

metadataobject

リクエストのメタデータ。 プロバイダーには送信されません。

prompt_cache_keystring

同じキャッシュを使うリクエストに、共通で指定するキー。 対応するモデルはプロンプトキャッシュを参照してください。

service_tierstringデフォルト値 standard

処理の優先度。 standard、default、standard_only、flex、priority を指定できます。 default と standard_only は standard として処理されます。

stop_sequencesstring[]

生成を終了させる文字列。

streambooleanデフォルト値 false

応答を、生成された部分から順に返すかどうか。 形式はストリーミングを参照してください。

systemstring | array

システムプロンプト。

temperaturenumber

出力のランダム性。 値が大きいほど多様な応答になります。

thinkingobject

拡張思考の設定。 { "type": "enabled", "budget_tokens": 1024 } のように指定します。 拡張思考に対応するモデルで指定できます。

tool_choiceobject

ツールを呼び出すかどうか、どのツールを呼び出すかの指定。 { "type": "auto" }、{ "type": "any" }、{ "type": "tool", "name": "..." } を指定します。

toolsarray

モデルが呼び出せるツールの一覧。 各ツールに name、description、input_schema を指定します。

top_kinteger

候補とするトークンの数の上限。

top_pnumber

候補とするトークンの累積確率の上限。

レスポンス

idstring

応答のID。

typestring

オブジェクトの種類。 常に message です。

rolestring

常に assistant です。

modelstring

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

contentarray

モデルが生成したコンテンツブロックの配列。 各ブロックの type は次のいずれかです。

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

テキスト。 text に本文が入ります。

thinkingobject

モデルの思考の内容。

tool_useobject

モデルが要求したツールの呼び出し。 id、name、input を含みます。

stop_reasonstring

生成が終了した理由。 end_turn、max_tokens、stop_sequence、tool_use などの値をとります。

stop_sequencestring | null

生成の終了条件に一致した文字列。

usageobject

トークンの使用量。

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

入力のトークン数。

output_tokensinteger

出力のトークン数。

エラー

リクエストボディの検証エラーはOpenAI互換の形式、それ以外のエラーはAnthropic互換の形式で返ります。 エラーの一覧はエラーを参照してください。

ステータスコード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サービスが一時的に利用できない