Messages
https://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 が返ります。
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 | 原因 |
|---|---|---|
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 | サービスが一時的に利用できない |