常用工具接入

支援自訂 OpenAI 相容位址的用戶端通常只需設定 Base URL、API Key 和模型 ID。模型目錄以 /v1/models 的即時結果為準。

OpenAI 相容用戶端涵蓋模型目錄、文字對話、圖片生成、影片任務和文字轉語音介面；素材庫介面使用平台自己的 /api/v1/materials/... 路徑，請按素材庫介面直接發起 HTTP 請求，用戶端不負責這部分。

通用設定

設定項	值
Base URL	`https://locopalai.com/v1`
API Key	主控台建立的 `sk-...`
模型 ID	`/v1/models` 傳回的 `data[].id`
Chat 路徑	`/chat/completions`
Models 路徑	`/models`

如果工具要求填寫完整 URL，使用 https://locopalai.com/v1/chat/completions；如果要求 Base URL，填寫到 /v1 即可。

平台還可能顯示 https://us-api.locopalai.com 等面向海外模型或特定網路環境的位址。接入時使用主控台目前顯示的位址；不要同時把兩個網域寫進同一個用戶端設定。

OpenAI JavaScript SDK

npm install openai

import OpenAI from 'openai'

const client = new OpenAI({
  apiKey: process.env.LOCOPAL_API_KEY,
  baseURL: 'https://locopalai.com/v1',
})

const models = await client.models.list()
const result = await client.chat.completions.create({
  model: models.data[0].id,
  messages: [{ role: 'user', content: '你好' }],
})
console.log(result.choices[0].message.content)

OpenAI Python SDK

pip install openai

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ["LOCOPAL_API_KEY"],
    base_url="https://locopalai.com/v1",
)
models = client.models.list()
response = client.chat.completions.create(
    model=models.data[0].id,
    messages=[{"role": "user", "content": "你好"}],
)
print(response.choices[0].message.content)

Cherry Studio

開啟模型服務設定，新增 OpenAI 相容服務。
API 位址填寫 https://locopalai.com/v1。
API Key 填寫主控台建立的金鑰。
點擊取得模型，或手動填寫 /v1/models 傳回的模型 ID。
儲存後新建對話驗證。

若模型清單為空，先用 curl 驗證同一 Key 的 /v1/models；若 curl 正常，檢查用戶端是否重複拼接 /v1。

OpenCode

在使用者層級或專案層級 opencode.json 設定 OpenAI 相容 Provider：

{
  "$schema": "https://opencode.ai/config.json",
  "provider": {
    "locopal": {
      "npm": "@ai-sdk/openai-compatible",
      "name": "LocoPal Ai",
      "options": {
        "baseURL": "https://locopalai.com/v1",
        "apiKey": "{env:LOCOPAL_API_KEY}"
      },
      "models": {
        "你的模型ID": { "name": "你的模型ID" }
      }
    }
  },
  "model": "locopal/你的模型ID"
}

設定語法可能隨用戶端版本變化，請以目前用戶端設定規範為準。關鍵是 Base URL、API Key 和模型 ID 三項一致。

Trae 與其他 IDE

在「設定 → 模型 → 新增模型」中選擇 OpenAI 相容格式：

關閉「完整 URL」時填寫 https://locopalai.com/v1。
開啟「完整 URL」時填寫 https://locopalai.com/v1/chat/completions。
填寫 API Key。
填寫目前可用模型 ID。
依模型真實能力開啟視覺或工具呼叫選項。

Postman / Apifox

建立 base_url=https://locopalai.com、api_key=你的APIKey 和 model=从 /v1/models 获取的模型 ID 三個環境變數。每個請求加入：

Authorization: Bearer {{api_key}}
Content-Type: application/json

影片任務先保存建立回應中的 ID，再用 GET 查詢 {{base_url}}/v1/video/generations/{{task_id}}。

伺服器端代理建議

瀏覽器和行動應用不要直接持有平台 API Key。推薦架構為「網頁或 App → 你的業務後端 → LocoPal Ai」。業務後端負責使用者驗證、參數驗證、請求日誌、任務 ID 持久化、額度控制和結果轉存。

接入自檢

GET /v1/models 傳回至少一個模型。
文字呼叫能得到 choices。
影片建立能得到任務 ID。
影片查詢能傳回狀態，且不會重複建立。
目前分組提供文字轉語音模型時，POST /v1/audio/speech 能傳回可播放的二進位音訊。
401 時檢查 Key，429 時依提示等待，5xx 時保存 RequestId 後判斷是否可重試。

本頁目錄