跳到主要内容
LocoPal AiLocoPal Ai
API 接入

使用指南

接口总览

全部公开接口、认证方式与对应的详细文档

查看 Markdown

接口总览

基础地址统一是 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同步素材状态
创建真人扫码授权会话POST/api/v1/materials/portrait/sessions真人素材授权
确认真人扫码完成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,以当前 Key 的模型目录及实际模型能力为准。

虚拟素材

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 状态和响应体。完整的错误码与排查方式见错误码与排查。

这一页有帮助吗?

本页目录