整合導覽驗證端點約定模型錯誤
StarmodelStarmodel
開始使用API 參考

驗證

Starmodel 的每個接口都需要 API Key,透過 Authorization 請求標頭傳入。

取得 API Key

  1. 開啟 API Keys 頁面 — 登入 Starmodel 控制台,開啟 API Keys 頁面。
  2. 產生新 Key — 點擊 新增 Key。完整 Key(sk-…)只會顯示一次——請立即複製並妥善保存到密鑰庫。
  3. 命名並管理 Key — 為 Key 加上描述以便區分用途。你可以隨時在同一頁面停用、重新啟用或刪除任意 Key。

完整 Key 僅在建立時顯示一次,遺失後無法找回——請停用舊 Key 並重新產生。

發起帶驗證的請求

把 Key 作為 Bearer token 放入 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 並傳入你的 Key:

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",});

最佳實踐

  • 切勿把 Key 提交到程式碼倉庫。 使用環境變數、已 gitignore 的 .env 檔案或密鑰管理服務。
  • 定期輪換。 團隊成員離職、疑似外洩或按固定週期時,產生新 Key 並停用舊 Key。
  • 一個業務一個 Key。 按服務拆分 Key,外洩時便於界定範圍並單獨停用,不影響其他流量。
  • 只在伺服器端使用。 像對待資料庫密碼一樣對待 Key——絕不要打包進瀏覽器或行動端 App。

錯誤

驗證失敗會回傳 JSON 錯誤內容:

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

狀態碼:

狀態碼含義
401缺少或無效的 API Key。
403Key 已被停用,或無權存取所請求的資源。
429觸發限流——請按 Retry-After 回應標頭中的時間後重試。

On this page

取得 API Key發起帶驗證的請求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": "你好" }
    ]
  }'