APIの概要
ゲートウェイが公開するすべてのエンドポイントと、それぞれが使用する形式、返す内容。
エンドポイントは三つ。リクエスト形式は二つ。キーは一つ。
| メソッド | パス | 形式 | 用途 |
|---|---|---|---|
| POST | /v1/messages | Anthropic Messages | チャット補完、Anthropic エンベロープ |
| POST | /v1/chat/completions | OpenAI Chat Completions | チャット補完、OpenAIエンベロープ |
| GET | /v1/models | OpenAI形式のリスト | お使いのキーで呼び出せるモデルID |
機械可読の説明は次の場所で公開されています： /openapi.json。サイト全体のプレーンテキストの要約はこちら： /llms.txt と /llms-full.txt.
エンドポイントの選択
これらは、次の条件でモデルへのアクセスを提供します： 同じモデルを同じ料金で利用可能。クライアントがすでに送信している形式に合わせて選択してください。形式を自分で変換する必要はありません。
| エンドポイント | 認証ヘッダー | レスポンスの構造 | ストリーミング |
|---|---|---|---|
/v1/messages | x-api-key またはBearer | content[] 配列 + usage | SSE、 content_block_delta イベント |
/v1/chat/completions | Bearer | choices[].message.content | SSE、 choices[].delta.content チャンク |
ストリーミングの構造は異なり、互換性がありません。次の形式に対応するクライアントは、
choices[].delta.content Messagesのストリームから何も読み取れません。参照： ストリーミング.共通ヘッダー
| ヘッダー | 適用対象 | 備考 |
|---|---|---|
content-type: application/json | 両方のPOST | 必須 |
x-api-key | Messages | Anthropic形式 |
Authorization: Bearer | 両方 | OpenAI形式。Messagesでも使用可能 |
anthropic-version: 2023-06-01 | Messages | AnthropicのSDKが自動的に設定 |
accept: text/event-stream | 両方 | SDKが設定する条件： stream がtrueの場合 |