ドキュメントクライアント設定汎用クライアント設定

汎用クライアント設定

クライアントが対応するプロトコルを使って、汎用 AI クライアントを SoleAPI に接続します。

汎用クライアント設定

クライアントが Anthropic Messages、OpenAI Responses、または OpenAI Chat Completions に対応していれば、このページの手順で SoleAPI に接続できます。設定項目の名称はクライアントごとに異なりますが、正しいプロトコルを選び、対応するエンドポイントへリクエストを送ることが基本です。現在、SoleAPI の OpenAI Chat Completions 向け供給元は少なく、OpenAI（GPT）と xAI（Grok）での利用を確認しています。

開始する前に、コンソールで API Key を作成し、対象モデルのグループが含まれていることを確認してから、モデルカタログでモデル ID をコピーしてください。

プロトコル互換とは、リクエストとレスポンスが対応する形式に従うことを意味します。すべてのモデルがそのプロトコルの全機能に対応するという意味ではありません。通常のテキストリクエストが成功しても、ツール、画像、推論、キャッシュなどの拡張機能が必ず使えるとは限りません。

最初にクライアントのフィールド形式を確認する

クライアントのカスタムモデル、プロバイダー、または接続設定で、プロトコル形式、Base URL（または API Endpoint）、API Key、モデル ID を探します。クライアントによって、ベースアドレスを要求する場合と完全なリクエスト URL を要求する場合があります。入力前にどちらかを確認してください。

クライアントによるパスの追加方法Anthropic MessagesOpenAI ResponsesOpenAI Chat Completions
/v1/messages を自動追加https://soleapi.com該当なし該当なし
/messages、/responses、または /chat/completions を自動追加https://soleapi.com/v1https://soleapi.com/v1https://soleapi.com/v1
完全なリクエスト URL を要求https://soleapi.com/v1/messageshttps://soleapi.com/v1/responseshttps://soleapi.com/v1/chat/completions
API KeySoleAPI API KeySoleAPI API KeySoleAPI API Key
モデル IDモデルカタログのモデル IDモデルカタログのモデル IDモデルカタログのモデル ID

ベースアドレスと完全なリクエスト URL を同時に使わないでください。対応パスを自動追加する Base URL フィールドに https://soleapi.com/v1/messages、https://soleapi.com/v1/responses、https://soleapi.com/v1/chat/completions を入力したり、完全な URL を要求するフィールドに https://soleapi.com/v1 を入力したりすると、/v1 やプロトコルパスが重複します。クライアントまたは provider のパス追加仕様に従ってください。

方法 1：Anthropic Messages

クライアントで Anthropic、Anthropic Messages、または同等のプロトコルを選択します。

  • /v1/messages が自動追加される場合：https://soleapi.com
  • /messages が自動追加される場合：https://soleapi.com/v1
  • 完全なリクエスト URL を要求する場合：https://soleapi.com/v1/messages
  • API Key：SoleAPI コンソールで作成した Key
  • モデル ID：モデルカタログに表示されるモデル ID
  • 認証方式：選択できる場合は Anthropic API Key または x-api-key

通常、クライアントは x-api-key や anthropic-version などのヘッダーを自動送信します。API Key 欄には Key のみを入力し、Bearer を手動で付けないでください。

この設定は SoleAPI の POST /v1/messages エンドポイントを使用します。フィールドとリクエスト例は Messages APIを参照してください。

方法 2：OpenAI Responses

クライアントで OpenAI Responses、Responses API、または同等のプロトコルを選択します。

  • /responses が自動追加される場合：https://soleapi.com/v1
  • 完全なリクエスト URL を要求する場合：https://soleapi.com/v1/responses
  • API Key：SoleAPI コンソールで作成した Key
  • モデル ID：モデルカタログに表示されるモデル ID
  • 認証方式：選択できる場合は OpenAI Bearer Token または同等の項目

クライアントは Authorization: Bearer <API Key> ヘッダーを自動送信します。通常、API Key 欄には Key のみを入力します。異なる場合はクライアントの説明に従ってください。

この設定は SoleAPI の POST /v1/responses エンドポイントを使用します。フィールドとレスポンス例は Responses APIを参照してください。

方法 3：OpenAI Chat Completions

クライアントで OpenAI Chat Completions、OpenAI Compatible、または同等のプロトコルを選択します。単に OpenAI と表示されるクライアントもあるため、Responses ではなく Chat Completions が実際に使われることを確認してください。

  • /chat/completions が自動追加される場合：https://soleapi.com/v1
  • /v1/chat/completions が自動追加される場合：https://soleapi.com
  • 完全なリクエスト URL を要求する場合：https://soleapi.com/v1/chat/completions
  • API Key：SoleAPI コンソールで作成した Key
  • モデル ID：モデルカタログに表示されるモデル ID
  • 認証方式：OpenAI Bearer Token または同等の項目を選び、Authorization: Bearer <API Key> を自動送信させます。

この設定は SoleAPI の POST /v1/chat/completions エンドポイントを使用します。現在、OpenAI（GPT）と xAI（Grok）の供給元が利用可能であることを確認しています。多くの中国製モデル自体もこのプロトコルに対応していますが、SoleAPI には該当する供給元がまだ追加されていません。

プロバイダーに応じてプロトコルを選ぶ

現在 SoleAPI で利用できるプロトコルエンドポイントはプロバイダーごとに異なります。API 互換プロトコルのプロバイダーとプロトコル表を確認し、対象モデルで利用できるエンドポイントに合うクライアントプロトコルを選択してください。

この表をプロバイダーとプロトコルの対応に関する正式な説明とし、本ページでは重複して管理しません。実際の設定では、モデルカタログに表示されるモデル ID と、現在の API Key で利用できるモデルも確認してください。

OpenCode での追加確認

OpenCode の組み込み Anthropic provider は baseURL を /v1 のプレフィックスとして使用し、その後に /messages を追加します。そのため、OpenCode のネイティブ Anthropic 設定では次の値を使用します。

json
{
  "provider": {
    "anthropic": {
      "options": {
        "baseURL": "https://soleapi.com/v1"
      }
    }
  }
}

設定画面の「OpenAI」や「Compatible」という表示だけでプロトコルを判断しないでください。OpenCode が @ai-sdk/openai-compatible を使用している場合、通常は /v1/chat/completions にリクエストを送ります。これは Anthropic Messages ではありません。/v1/messages を呼び出すには、OpenCode の Anthropic provider、または Anthropic Messages を明示的に使う provider を使用してください。

実際のリクエストパスからプロトコルを判断できます。

  • /v1/messages：Anthropic Messages。次にリクエスト本文のツールや拡張フィールドを確認します。
  • /v1/responses：OpenAI Responses。クライアントが Responses provider を使用しているか確認します。
  • /v1/chat/completions：OpenAI Chat Completions。現在、SoleAPI では GPT と Grok の供給元を確認済みですが、中国製モデルの該当供給元はまだ追加されていません。
  • /messages：通常は Base URL に /v1 が不足しています。クライアントのパス追加仕様に従って補ってください。

SoleAPI における OpenAI Chat Completions の現在の範囲

POST /v1/chat/completions は過去との互換性のために残されているエンドポイントで、新規接続の第一候補には推奨しません。OpenAI（GPT）と xAI（Grok）は現在このエンドポイントを使用できます。多くの中国製モデル自体も Chat Completions に対応していますが、SoleAPI には該当する供給元がまだ追加されていないため、現在このプロトコルでは利用できません。

これは、中国製モデルが Chat Completions に対応していない、または利用できないという意味ではありません。モデルカタログと API Key で利用できるモデルを確認し、SoleAPI で現在利用可能なプロトコルを選んでください。中国製モデルでは、利用可能な Messages または Responses エンドポイントを使用できます。

テストして保存する

設定を保存し、まずテキストだけの簡単なリクエストを送信します。基本リクエストが成功した後に、ツール、ストリーミング、画像、推論などを個別にテストしてください。

次の順序で確認します。

  1. モデル ID が正しく、現在の API Key で利用できるグループに属していることを確認します。
  2. プロトコルとパスを一致させます。Messages は /v1/messages、Responses は /v1/responses、Chat Completions は /v1/chat/completions です。
  3. Base URL と完全なリクエスト URL を混同していないことを確認します。
  4. 動作確認済みのモデルでテストしてから、対象モデルへ切り替えます。
  5. テキストが成功した後に、ツール呼び出しなどの高度な機能を個別に確認します。

同じプロトコルでもクライアントによって結果が異なる理由

「Anthropic Messages に対応」とは、その形式のリクエストを生成できるという意味にすぎません。クライアントごとに次の違いがあります。

  • パスの追加方法が異なり、/messages、/v1/messages、/v1/chat/completions など別の入口へ送信される。
  • 認証ヘッダー、anthropic-version、anthropic-beta ヘッダーが異なる。
  • コーディングエージェントがツール定義、tool_choice、システムプロンプト、長いコンテキストを自動追加する。
  • プロンプトキャッシュ、推論パラメータ、画像コンテンツ、特定のストリーミングイベントを有効にするクライアントがある。
  • ツール呼び出し、ストリーミングイベント、エラーレスポンスの解析要件が異なる。

あるクライアントで通常の会話が成功しても、そのリクエストを処理できたことだけが確認できます。別のクライアントの完全なエージェント処理まで互換であるとは限りません。たとえば、あるクライアントでは GLM が Anthropic Messages でテキストを返す一方、別のコーディングクライアントで失敗する場合、モデル入口の問題と判断する前に、後者がツールや拡張フィールドを追加していないか確認してください。

トラブルシューティング

  • 404 またはエンドポイントが存在しない：プロトコルとパスを一致させます。Messages は /v1/messages、Responses は /v1/responses、Chat Completions は /v1/chat/completions です。
  • パスに /v1/v1/messages、/v1/v1/responses、重複した /v1、または重複したプロトコルパスが含まれる：Base URL にすでにバージョンパスが含まれているか、クライアントが自動追加しています。実際の追加方法に合うベースアドレスを使用してください。
  • 401：API Key が完全で、有効かつ期限切れでないこと、および認証方式がプロトコルと一致することを確認します。
  • 403：API Key に対象モデルグループが含まれていることを確認します。IP ホワイトリストを有効にしている場合は、現在の端末 IP を追加してください。
  • テキストは成功するがツール呼び出しが失敗する：通常、基本プロトコルは動作していますが、モデルまたは上流エンドポイントがクライアントのツールパラメータを受け付けていません。ツールを無効にするか、ツール対応を確認済みのモデルと比較してください。
  • あるクライアントでは成功し、別のクライアントでは失敗する：実際のリクエストパス、ヘッダー、本文を比較します。設定画面のプロトコル名だけでなく、ツール定義、tool_choice、推論・キャッシュフィールド、ストリーミングイベントを確認してください。
  • モデルが存在しない、または利用可能なエンドポイントがない：モデルカタログでモデル ID を確認し、現在の API Key で利用できることを確認します。中国製モデルで Chat Completions が失敗した場合、モデル自体が非対応と判断せず、SoleAPI に該当供給元がまだ追加されていないことを確認してください。現在利用可能な Messages または Responses エンドポイントへ切り替えられます。