Перейти к основному содержанию
LocoPal AiLocoPal Ai
Подключение к API

Руководство

Обзор API

Все публичные эндпоинты, способы аутентификации и ссылки на подробную документацию

Показать Markdown

Обзор API

Базовый адрес единый — https://locopalai.com, все эндпоинты используют один и тот же платформенный API Key. Общие соглашения (аутентификация, структура ответа, пагинация, ограничение частоты запросов, идемпотентность) описаны в разделе Аутентификация и базовые соглашения.

Модели и интерфейсы генерации

НазначениеМетодПутьПодробная документация
Получение списка доступных моделейGET/v1/modelsМодели и текстовый интерфейс
Текстовый диалог (включая потоковый режим)POST/v1/chat/completionsМодели и текстовый интерфейс
Генерация изображенийPOST/v1/images/generationsИнтерфейс генерации изображений
Синтез речи из текстаPOST/v1/audio/speechИнтерфейс синтеза речи
Создание видеозадачиPOST/v1/video/generationsИнтерфейс генерации видео
Запрос видеозадачиGET/v1/video/generations/{task_id}Интерфейс генерации видео
Создание видеозадачи (OpenAI-совместимый формат)POST/v1/videosИнтерфейс генерации видео
Запрос видеозадачи (OpenAI-совместимый формат)GET/v1/videos/{task_id}Интерфейс генерации видео

Интерфейсы библиотеки материалов

Интерфейсы библиотеки материалов используют API Key, при успехе единообразно возвращается { "code": 0, "data": ..., "msg": "..." }.

НазначениеМетодПутьПодробная документация
Запрос групп материаловGET/api/v1/materials/groupsГруппы материалов
Создание группы материалов (virtual / real)POST/api/v1/materials/groupsГруппы материалов
Список материалов (поддерживает group_id, пагинацию)GET/api/v1/materials/assetsМатериалы
Отправка материала-изображения (image_url или data_url)POST/api/v1/materials/assetsМатериалы
Запрос статуса одного материалаGET/api/v1/materials/assets/{asset_id}Материалы
Синхронизация статуса материалаPOST/api/v1/materials/syncСинхронизация статуса материала
Создание сессии авторизации образа человека по QR-кодуPOST/api/v1/materials/portrait/sessionsРазрешение на использование образа
Подтверждение завершения сканирования QR-кода человекомPOST/api/v1/materials/portrait/resolveРазрешение на использование образа

Подробные параметры, примеры и описание ошибок см. в разделе Обзор интерфейсов библиотеки материалов.

Типичные цепочки вызовов

Модели и видео

GET  /v1/models
  → POST /v1/video/generations
  → GET  /v1/video/generations/{task_id}

После создания задачи обязательно сохраните ID задачи; при обрыве сети продолжайте запрашивать исходную задачу и не создавайте её повторно.

Синтез речи из текста

GET  /v1/models
  → POST /v1/audio/speech
  → 保存二进制音频响应

Доступность аудиоинтерфейса, поддерживаемые voice и response_format определяются каталогом моделей текущего ключа и фактическими возможностями модели.

Виртуальные материалы

POST /api/v1/materials/groups
  → POST /api/v1/materials/assets
  → GET  /api/v1/materials/assets/{asset_id}   (轮询到 status 为 Active)
  → 在视频 content 中使用 asset://<asset_id>

Материалы реального человека

POST /api/v1/materials/groups {"type":"real"}
  → POST /api/v1/materials/portrait/sessions   (拿到二维码链接)
  → 由真人本人扫码完成采集
  → POST /api/v1/materials/portrait/resolve
  → POST /api/v1/materials/sync
  → 查询素材状态后用于支持真人素材库的模型

Сквозной пример см. в разделе Процесс подключения портретных материалов и референсного видео; ограничения возможностей при работе с несколькими изображениями и референсным видео описаны в разделе Несколько изображений и референсное видео.

Ответы и ошибки

Тип интерфейсаУспехОшибка
Модели / изображения / видеоНапрямую возвращается объект результатаHTTP не 2xx, читайте error.message
Библиотека материалов{ "code": 0, "data": ..., "msg": "OK" }Код состояния HTTP совпадает с code

Клиент должен проверять и HTTP-статус, и тело ответа. Полный список кодов ошибок и способы диагностики см. в разделе Коды ошибок и диагностика.

Эта страница была полезной?

На этой странице