跳到正文
LumiPath API

快速开始

创建 API Key,列出已连接的账号,上传并发布一条视频。

1. 创建 API Key

登录 LumiPath,打开 设置 → API Keys,生成一把 Key。 Key 以 lumi_ 开头,请像密码一样保管,见安全须知。

export LUMI_API_KEY="lumi_xxxxxxxx"

2. 列出账号连接

账号连接(connection) 是你在控制台里连接的一个社交账号。所有发布和读取接口都通过 connectionId 指定要操作的账号。

curl https://app.lumipath.cn/api/v1/connections \
  -H "Authorization: Bearer $LUMI_API_KEY"
{
  "success": true,
  "data": [
    {
      "connectionId": "665f1c2e9b1e8a0012345678",
      "platform": "tiktok",
      "username": "my_brand",
      "displayName": "My Brand"
    }
  ]
}

可以用 ?platform=tiktok 按平台筛选。如果返回空列表,请先在控制台连接一个账号。

3. 上传视频

平台会从 LumiPath 的存储拉取素材,所以先上传文件。可以传一个公网 URL(也可以用 multipart/form-data 发送 file 字段):

curl -X POST https://app.lumipath.cn/api/v1/videos/upload \
  -H "Authorization: Bearer $LUMI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "url": "https://example.com/video.mp4" }'
{ "url": "https://videos.lumipath.cn/…/video.mp4", "vid": "0b7f…", "mediaType": "video" }

4. 发布

使用上一步返回的 url。下面的示例发布到一个 TikTok 账号,并设为仅自己可见(SELF_ONLY),方便安全地测试。

curl -X POST https://app.lumipath.cn/api/v1/social-posts \
  -H "Authorization: Bearer $LUMI_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: quickstart-$(date +%s)" \
  -d '{
    "platforms": ["TIKTOK"],
    "contentType": "VIDEO",
    "text": "Hello from the LumiPath API",
    "mediaUrls": ["https://videos.lumipath.cn/…/video.mp4"],
    "tiktokConnectionIds": ["665f1c2e9b1e8a0012345678"],
    "tiktokConfigs": [{ "connectionId": "665f1c2e9b1e8a0012345678", "privacyLevel": "SELF_ONLY" }]
  }'
{
  "success": true,
  "results": {
    "TIKTOK": [
      { "connectionId": "665f1c2e9b1e8a0012345678", "status": "processing", "jobId": "6660a1..." }
    ]
  }
}

Idempotency-Key 让重试变得安全:同一个 Key 会直接返回第一次的响应,不会重复发帖(Key 保留 7 天)。示例每次运行都会生成新 Key。

processing 不代表已经发布成功。视频在后台上传,请保存 jobId,按下一步查询最终结果。

5. 查询结果

curl -X POST https://app.lumipath.cn/api/v1/social-posts/status \
  -H "Authorization: Bearer $LUMI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "jobIds": ["6660a1..."] }'

每隔几秒查询一次,直到该条的 status 变成 success(带 postId / postUrl)或 failed(带 error)。 完整流程见发布指南。

本页目录