常用工具接入

支持自定义 OpenAI 兼容地址的客户端通常只需配置 Base URL、API Key 和模型 ID。模型目录以 /v1/models 的实时结果为准。

通用配置

配置项	值
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 即可。

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": {
        "available-model-id": { "name": "available-model-id" }
      }
    }
  },
  "model": "locopal/available-model-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=sk-your-api-key 和 model=available-model-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。
视频查询能返回状态，且不会重复创建。
401 时检查 Key，429 时按提示等待，5xx 时保存 RequestId 后判断是否可重试。

本页目录