クイックスタート：API キーとモデル

利用可能なモデルを調べ、最初のテキストリクエストを送信します。

1. API キーを作成する

AIMirrorX コンソールにログインし、トークン／API キー管理画面でトークンを作成します。必要に応じてグループ、モデル権限、利用枠、有効期限を設定してください。画面の名称は現在のコンソールに従います。

キーは機密情報としてサーバー側の環境変数に保存します。フロントエンドのコード、Git リポジトリ、公開スクリーンショットには含めないでください。紛失や漏えい時は失効させて再作成します。サンプルの認証情報はすべてプレースホルダーです。

export AIMIRRORX_API_KEY='YOUR_API_KEY'

2. 利用可能なモデルを確認する

curl https://api.aimirrorx.com/v1/models \
  -H "Authorization: Bearer $AIMIRRORX_API_KEY"

レスポンスの data[].id から、トークンで利用でき、目的のプロトコルに対応する ID を選びます。以下の MODEL_ID_FROM_V1_MODELS を実際の ID に置き換えてください。参考資料に記載された上流のモデル名が利用できるとは限りません。

3. Chat Completions を呼び出す

curl https://api.aimirrorx.com/v1/chat/completions \
  -H "Authorization: Bearer $AIMIRRORX_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"model":"MODEL_ID_FROM_V1_MODELS","messages":[{"role":"user","content":"你好"}]}'

ストリーミング対応モデルでは "stream": true を追加し、curl -N で SSE を読み取れます。接続の切断は、上流で処理されなかったことを意味しません。二重課金を避けるため、自動再試行の前に使用量とリクエストログを確認してください。

4. SDK を利用する

OpenAI 互換 SDK の base_url は通常 https://api.aimirrorx.com/v1 に設定し、SDK が /chat/completions を追加します。完全なエンドポイント URL を設定したり、/v1 を重複させたりしないでください。SDK 自体が /v1 を追加する場合はオリジンを指定します。

import os
from openai import OpenAI

client = OpenAI(api_key=os.environ["AIMIRRORX_API_KEY"],
                base_url="https://api.aimirrorx.com/v1")
response = client.chat.completions.create(
    model="MODEL_ID_FROM_V1_MODELS",
    messages=[{"role": "user", "content": "你好"}],
)
print(response.choices[0].message.content)

よくある問題

401：キー、認証ヘッダー、有効期限を確認します。コンソールへのログイン情報は API キーではありません。
403 または利用可能なチャネルがない場合：トークンのグループ、モデル権限、チャネルの対応状況を確認します。
404：/v1 の重複や、ドキュメントのドメインを誤って使用していないか確認します。
429：サーバーの制限情報に従い、回数に上限を設けたバックオフで再試行します。
5xx またはタイムアウト：時刻、モデル、エンドポイント、リクエスト ID（ある場合）、機密情報を除いたエラーを記録し、コンソールのサポート窓口に連絡してください。実際のキーは送らないでください。