取得模型清單
取得平台目前可用的全部模型,依模型能力與模型廠商兩級分組。取得 modelId 後,可在其他需要指定模型的介面中引用。
本介面依帳號維度限流,60 次/分鐘。平台模型清單變動不頻繁,建議在呼叫端快取結果。
請求方法
GET
請求 URL
https://api-${endpoint}.gptbots.ai/v1/model/list
請求認證
本介面使用帳號維度的 DevKey / DevSecret,以 HTTP 基本認證傳遞:
Authorization: Basic base64(${DevKey}:${DevSecret})
即把 DevKey 與 DevSecret 用半形冒號串接後整體做 Base64 編碼,前面加上 Basic (注意有一個空格)。
DevKey / DevSecret 的取得方式:登入控制台,進入個人中心 - 帳號 - 開發者資訊,可查看**開發者識別碼(DevKey)**與 API DevSecret。
⚠️ 注意與 Agent 維度認證區分:對話等介面使用 Agent 的 API Key(
Authorization: Bearer ${API Key})進行驗證,本介面使用帳號的 DevKey / DevSecret + Basic 認證,兩者不可混用。Base64 是可逆編碼而非加密,請將編碼結果與明文密碼同等對待,不要提交進程式碼庫或寫入公開文件。
請求
請求範例
curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/model/list' \
-H 'Authorization: Basic ${base64(DevKey:DevSecret)}'
請求標頭
| 欄位 | 類型 | 描述 |
|---|---|---|
| Authorization | Basic base64({DevSecret}) | 使用帳號維度的 DevKey / DevSecret 進行 HTTP Basic 認證,請在個人中心 - 帳號 - 開發者資訊頁面取得憑證。 |
請求參數
無。
回應
回應範例
{
"code": 0,
"message": "OK",
"data": {
"CHAT": {
"OPEN_AI": [
{ "aiModelVersion": "gpt-4o", "modelId": "65f2c1a8d3b4e5f601234567" },
{ "aiModelVersion": "gpt-3.5-turbo", "modelId": "65f2c1a8d3b4e5f601234568" }
],
"ANTHROPIC_CLAUDE": [
{ "aiModelVersion": "claude-opus-4-8", "modelId": "65f2c1a8d3b4e5f601234569" }
]
},
"EMBEDDING": {
"OPEN_AI_EMB": [
{ "aiModelVersion": "text-embedding-3-large", "modelId": "65f2c1a8d3b4e5f60123456a" }
]
},
"RERANK": { },
"SPEECH2TEXT": { },
"TEXT2SPEECH": { },
"MODERATION": { },
"ANONYMIZATION": { }
}
}
成功回應
| 欄位 | 類型 | 描述 |
|---|---|---|
| code | int | 0 表示成功,非 0 見錯誤代碼。 |
| message | string | 結果描述,成功為 OK。 |
| data | JSON Object | 模型資料,依模型能力、模型廠商兩級分組,見下。 |
| aiModelVersion | string | 模型版本名稱,如 gpt-4o,用於顯示。 |
| modelId | string | 模型版本 ID,其他介面引用模型時使用該值。模型版本名稱可能因平台調整而變動,modelId 是穩定識別碼。 |
data 的兩級結構
data
└── 模型能力 外層 key,7 種,固定順序
└── 模型廠商 內層 key,如 OPEN_AI
└── [ 模型清單 ]
外層 key 為模型能力,固定為下列 7 種,且依此順序回傳:
| 能力 | 含義 |
|---|---|
| CHAT | 對話(大型語言模型) |
| EMBEDDING | 向量化 |
| RERANK | 向量重排 |
| SPEECH2TEXT | 語音辨識(ASR) |
| TEXT2SPEECH | 語音合成(TTS) |
| MODERATION | 內容審查 |
| ANONYMIZATION | 匿名化 |
內層 key 為模型廠商識別碼。以 CHAT 為例,可能出現的取值包括 OPEN_AI、AZURE、ANTHROPIC_CLAUDE、GEMINI、ALI_QWEN、DEEP_SEEK、KIMI、META_LLAMA、MISTRAL、ZHIPU_CHATGLM、HUNYUAN、ERINE、XAI_GROK、BYTEDANCE_SEED、SENSE 等;其他能力下的廠商識別碼不同(如 EMBEDDING 下有 OPEN_AI_EMB、JINA_EMB 等)。
- 某項能力目前無可用模型時,其值為空物件
{},key 仍會出現,不會被省略,遍歷前請先判空。- 平台會新增/下線廠商,請以介面實際回傳為準,不要將廠商清單硬編碼進程式碼。
- 廠商與模型依平台設定的顯示優先順序排序,排序僅供顯示參考,請勿依賴排序結果做業務邏輯(如「取第一個即預設模型」)。
失敗回應
| 欄位 | 類型 | 描述 |
|---|---|---|
| code | int | 錯誤代碼。 |
| message | string | 錯誤詳情。 |
錯誤代碼
| Code | Message |
|---|---|
| 40101 | Authorization 為空 |
| 40102 | Authorization 格式錯誤,請檢查 Basic 前綴(含空格)與 Base64 編碼是否正確 |
| 40001 | 請求超出頻率限制,本介面限流 60 次/分鐘 |
| 50000 | 服務內部錯誤,請稍後重試 |
