Руководство
Подключение популярных инструментов
Настройка OpenAI SDK, Cherry Studio, OpenCode, Trae и других совместимых клиентов
Подключение популярных инструментов
Клиентам с поддержкой пользовательского адреса, совместимого с OpenAI, обычно достаточно настроить Base URL, API Key и ID модели. Каталог моделей определяется актуальным результатом /v1/models.
Клиенты, совместимые с OpenAI, покрывают каталог моделей, текстовый диалог, генерацию изображений, видеозадачи и интерфейс синтеза речи; интерфейсы библиотеки материалов используют собственный путь платформы /api/v1/materials/... — отправляйте HTTP-запросы напрямую согласно разделу Интерфейсы библиотеки материалов; клиент эту часть не поддерживает.
Общая конфигурация
| Параметр | Значение |
|---|---|
| Base URL | https://locopalai.com/v1 |
| API Key | sk-..., созданный в консоли |
| ID модели | data[].id из ответа /v1/models |
| Путь 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 openaiimport 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 openaiimport 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 укажите ключ, созданный в консоли.
- Нажмите «Получить модели» или вручную введите ID модели из ответа
/v1/models. - Сохраните и создайте новый диалог для проверки.
Если список моделей пуст, сначала проверьте /v1/models для того же Key с помощью curl; если curl работает, проверьте, не дублирует ли клиент /v1 при склейке.
OpenCode
Настройте OpenAI-совместимый Provider в файле opencode.json на уровне пользователя или проекта:
{
"$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 из ответа создания, затем запросите {{base_url}}/v1/video/generations/{{task_id}} методом GET.
Рекомендации по серверному проксированию
Браузер и мобильное приложение не должны напрямую хранить API Key платформы. Рекомендуемая архитектура: «веб-страница или приложение → ваш бизнес-бэкенд → LocoPal Ai». Бизнес-бэкенд отвечает за аутентификацию пользователей, валидацию параметров, журналирование запросов, хранение ID задач, контроль квот и сохранение результатов.
Самопроверка подключения
GET /v1/modelsвозвращает хотя бы одну модель.- Текстовый вызов возвращает
choices. - Создание видео возвращает ID задачи.
- Запрос видео возвращает статус и не создаёт задачу повторно.
- Если текущая группа предоставляет модель синтеза речи,
POST /v1/audio/speechвозвращает воспроизводимое двоичное аудио. - При
401проверьте Key, при429подождите согласно подсказке, при5xxсохраните RequestId и решите, можно ли повторить запрос.
