統合ガイド認証エンドポイント規約モデルエラー
StarmodelStarmodel
はじめにAPI リファレンス

認証

Starmodel のすべてのエンドポイントは API キーが必要で、Authorization リクエストヘッダーで渡します。

API キーを取得する

  1. API Keys ページを開く — Starmodel コンソールにサインインし、API Keys ページを開きます。
  2. 新しいキーを生成する — 新規キー をクリックします。完全なキー文字列(sk-…)は一度だけ表示されます——すぐにシークレットストアにコピーしてください。
  3. キーに名前を付けて管理する — 用途がわかるように説明を追加します。同じページからいつでもキーを無効化・再有効化・削除できます。

完全なキーは作成時に一度だけ表示されます。紛失すると復元できません——古いキーを無効化して新しいキーを生成してください。

認証付きリクエストを送る

キーを Bearer トークンとして Authorization ヘッダーに含めます:

Authorization: Bearer <API Key>

最小限のリクエスト例:

curl https://api.starmodel.ai/v1/chat/completions \  -H "Authorization: Bearer $API_KEY" \  -H "Content-Type: application/json" \  -d '{    "model": "あなたのモデル ID",    "messages": [      { "role": "user", "content": "こんにちは" }    ]  }'

同じヘッダーがすべてのエンドポイントで使えます——チャット、画像、動画、音声、そして GET /v1/models。

SDK のセットアップ

OpenAI 互換の SDK の多くは base_url の上書きに対応しています。Starmodel に向けてキーを渡してください:

from openai import OpenAIclient = OpenAI(    api_key=os.environ["API_KEY"],    base_url="https://api.starmodel.ai/v1",)
import OpenAI from "openai";const client = new OpenAI({  apiKey: process.env.API_KEY,  baseURL: "https://api.starmodel.ai/v1",});

ベストプラクティス

  • キーをソース管理にコミットしない。 環境変数、gitignore した .env ファイル、またはシークレットマネージャーを使います。
  • 定期的にローテーションする。 メンバーの離脱時、漏洩の疑いがあるとき、または一定の周期で、新しいキーを生成し古いキーを無効化します。
  • ワークロードごとに 1 キー。 サービス単位のキーなら、漏洩時に範囲を限定して個別に無効化でき、他のトラフィックに影響しません。
  • サーバーサイドのみ。 キーはデータベースのパスワードと同じ扱いに——ブラウザのバンドルやモバイルアプリに含めないでください。

エラー

認証失敗時は JSON のエラー本文が返ります:

{  "error": {    "code": "unauthorized",    "message": "unauthorized",    "type": "error"  }}

ステータスコード:

ステータス意味
401API キーがない、または無効です。
403キーが無効化されているか、要求されたリソースへのアクセス権がありません。
429レート制限を超過しました——Retry-After ヘッダーの時間だけ待ってから再試行してください。

On this page

API キーを取得する認証付きリクエストを送るSDK のセットアップベストプラクティスエラー
Authorization: Bearer <API Key>
from openai import OpenAI

client = OpenAI(
    api_key=os.environ["API_KEY"],
    base_url="https://api.starmodel.ai/v1",
)
import OpenAI from "openai";

const client = new OpenAI({
  apiKey: process.env.API_KEY,
  baseURL: "https://api.starmodel.ai/v1",
});
{
  "error": {
    "code": "unauthorized",
    "message": "unauthorized",
    "type": "error"
  }
}
curl https://api.starmodel.ai/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "あなたのモデル ID",
    "messages": [
      { "role": "user", "content": "こんにちは" }
    ]
  }'