使用指南
快速开始
从注册登录、创建凭据到完成第一次模型和素材调用
面向平台用户的操作步骤与创作流程说明
快速开始
LocoPal Ai 提供模型 API、异步视频、素材库、LocoPal Creation 和 Agent。模型调用使用 API Key;素材分组、素材状态和真人授权使用 AccessKey / SecretKey。两类凭据用途不同,不能互换。
1. 登录并确认账户
访问 LocoPal Ai,登录后进入控制台。调用前确认账户可用、余额或套餐额度充足。团队或多套业务建议分别创建凭据,便于按应用查看日志和停用泄露的密钥。
| 入口 | 用途 | 凭据 |
|---|---|---|
| 模型广场 | 查看模型 ID、能力、参数和价格 | 无 |
| API 密钥 | 调用文本、图片、视频等模型 | API Key |
| AccessKey 管理 | 调用素材分组、素材、真人授权接口 | AccessKey / SecretKey |
| 使用日志 | 查询同步模型调用和计费记录 | 登录态 |
| 任务日志 | 查询视频等异步任务状态 | 登录态 |
| 素材库管理 | 管理虚拟人物和真人素材 | 登录态 |
2. 创建 API Key
进入控制台“API 密钥”,点击创建。API Key 只应保存在服务端环境变量或密钥管理服务中。
export LOCOPAL_API_KEY="sk-your-api-key"
export LOCOPAL_BASE_URL="https://locopalai.com"不要把 API Key 写进网页源码、移动端安装包、公开仓库、错误日志或截图。怀疑泄露时立即停用旧 Key 并创建新 Key。
3. 查询可用模型
curl "https://locopalai.com/v1/models" \
-H "Authorization: Bearer $LOCOPAL_API_KEY"{
"object": "list",
"data": [
{ "id": "available-model-id", "object": "model", "owned_by": "provider" }
]
}请求中的 model 必须使用 data[].id。模型目录与用户分组和实时可用性有关,不要在业务代码中永久写死展示名称。
4. 第一次文本调用
curl "https://locopalai.com/v1/chat/completions" \
-H "Authorization: Bearer $LOCOPAL_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "available-text-model-id",
"messages": [
{ "role": "user", "content": "用三句话介绍这个产品" }
],
"stream": false
}'成功时从 choices[0].message.content 读取文本,并保存响应中的请求标识与 usage。开启 stream: true 后按 SSE 逐段读取,收到 [DONE] 后结束。
5. 第一次视频调用
视频是异步任务:创建接口返回任务 ID,查询接口返回进度和结果。
curl "https://locopalai.com/v1/video/generations" \
-H "Authorization: Bearer $LOCOPAL_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "available-video-model-id",
"content": [
{ "type": "text", "text": "清晨的湖边,镜头缓慢向前推进" }
],
"resolution": "720p",
"ratio": "16:9",
"duration": 5
}'{
"id": "task-public-id",
"task_id": "task-public-id",
"status": "queued"
}查询同一个任务:
curl "https://locopalai.com/v1/video/generations/task-public-id" \
-H "Authorization: Bearer $LOCOPAL_API_KEY"创建响应已返回任务 ID 后,即使本地等待超时,也应继续查询原任务;不要自动重复创建,否则可能产生重复任务和费用。
6. 创建素材 AccessKey
打开“AccessKey 管理”,创建一对 AccessKey / SecretKey。SecretKey 只在创建成功时完整显示一次,请立即保存。
export LOCOPAL_ACCESS_KEY="AKLTxxxxxxxx"
export LOCOPAL_SECRET_KEY="your-secret-key"素材接口使用 HMAC-SHA256 签名,入口统一为:
POST https://locopalai.com/api/v3?Action=<Action>&Version=2024-01-01完整签名代码、虚拟分组、素材入库、单个素材状态查询和真人扫码授权请阅读素材库 API。
7. 创建真人素材
进入“素材库管理”,选择“真人素材”,阅读并同意授权协议后生成二维码。由素材本人使用手机扫码完成采集;网页显示完成后,点击同步即可查看真人素材分组和处理状态。
通过 API 接入时,请阅读真人素材授权接口,其中包含请求参数、二维码会话、完成确认和响应示例。
