概要

エンドポイント

すべてのエンドポイントは、単一のベース URL の下にあり、HTTPS で提供されます。

https://api.shannon-ai.com

テキストを生成する三つのエンドポイントは、同じモデルに到達します。お使いのコードがすでに使っている形式のものを選んでください。

リクエストの基本

• すべての POST のボディは、最大 32 MiB の単一の JSON オブジェクトです。
• API が知らないフィールドは、エラーにならず、何の影響もありません。他のプロバイダー向けに書かれたリクエストが、余分なフィールドのために失敗することはありません。
• 既知のフィールドの JSON 型が正しくない場合や、必須フィールドがない場合は、422 で応答します。有効な JSON ではないボディには 400 で応答します。
• model は、モデルと料金のページにある ID のいずれかです。大文字と小文字は区別されません。

応答は JSON、またはリクエストで stream を true に設定した場合は server-sent events のストリームです。各エンドポイントは、それぞれの形式で応答します。すべての応答に x-request-id ヘッダーが付きます。

リクエストが通過する確認

リクエストは、モデルが実行される前に、決まった順序で確認されます。最初に失敗した確認が応答するため、401 が返った段階では、ボディについてまだ何も分かりません。

エラーの形式

エラーは、type と message を持つ error を含む JSON オブジェクトです。/v1/messages は Anthropic SDK が期待する形で包み、それ以外のパスはすべて OpenAI の形式を使います。

{
  "error": {
    "type": "invalid_request_error",
    "message": "unknown model: gpt-4o"
  }
}

{
  "type": "error",
  "error": {
    "type": "invalid_request_error",
    "message": "unknown model: gpt-4o"
  }
}

• type と message を読んでください。code と param は一部のエラーにのみ含まれるため、省略可能なものとして扱ってください。param は常に null です。
• ストリームが始まった後は、ステータスはすでに 200 です。その後の失敗は、ストリーム内のエラーフレームとして届きます。
• すべてのエラー応答に x-request-id ヘッダーが付きます。

エラー処理

課金と残高

• 残高はアカウントごとにひとつで、チャットと API で共有されます。まず本日のプラン枠、次に購入済みクレジットが消費されます。API 専用の枠はありません。
• リクエストは出力バジェット（max_tokens、デフォルトは 4,096）を確保し、その後、実際に使用したトークンに対して、モデルの価格で課金されます。
• すべての応答は、トークン数を usage で報告します。キーと使用量のページには、残高と各リクエストのコストが表示されます。
• すべてのリクエストは平等に処理されます。リクエスト頻度に関する唯一の制限は、フラッド保護（アカウントあたり一分間に 120 リクエスト）です。並列に送信されたリクエストは順番待ちになります。

上限と残高 モデルと料金 キーと使用量

モデルによって異なるフィールド

どのモデルも同じリクエストを受け付けます。一部のフィールドは、特定のモデルでのみ有効です。どのモデルかは表に示しています。すべてのフィールドは、各エンドポイントのページに一覧があります。

Chat Completions

OpenAI SDK から移行する場合

• ベース URL を https://api.shannon-ai.com/v1 に設定し、キーを Shannon のキーにします。すると、Chat Completions と Responses の呼び出しは、SDK をそのまま使って動作します。
• model は Shannon の ID でなければなりません。gpt-4o のような他のプロバイダーのモデル名には、400 と unknown model で応答します。
• 推論は専用のフィールドで届きます。メッセージとストリームのデルタで、content と並んで reasoning_content に入ります。
• ストリームは、最後のチャンクに必ず usage を finish_reason とともに含みます。
• ストリーム内のツール呼び出しは、完全な arguments 文字列を含むひとつのチャンクとして届きます。
• 応答の選択肢はひとつです。
• 上の表にない OpenAI API のパス（/v1/embeddings など）には、404 で応答します。

Anthropic SDK から移行する場合

• ベース URL を https://api.shannon-ai.com に設定し（/v1 は付けません）、キーを Shannon のキーにします。SDK はそれを x-api-key として送信します。
• model は Shannon の ID でなければなりません。
• この API では max_tokens は任意です。デフォルトは 4,096 です。
• 応答には、タイプ thinking、text、tool_use のコンテンツブロックが含まれます。最初のブロックが常にテキストとは限りません。ブロックは type で選んでください。
• stop_reason は end_turn または tool_use です。Shannon モデルのストリームは max_tokens で終了することもあります。
• anthropic-version と anthropic-beta は受け付けられるため、SDK はそのまま動作します。リクエストにこれらは必須ではありません。
• /v1/messages のエラーは Anthropic の形式です：{"type": "error", "error": {…}}。

これらの形式に対応するコーディングツールも同じように設定します。ベース URL、キー、そしてモデルとして Shannon の ID です。 CLI コーディングツール