VlogMe / 开发者

面向代码、AI 智能体与 LLM 的 AI 视频生成 API。

通过 REST API 估算并创建 VlogMe AI 视频,也可使用原生 Streamable HTTP MCP 连接 AI 智能体。支持异步任务、Webhook 与口播数字人生成。

AI 智能体
REST API
MCP
生成任务
Webhook
curl https://vlogme.ai/api/v2/projects \
  -X POST \
  -H "Authorization: Bearer $VLOGME_TOKEN" \
  -H "Idempotency-Key: quickstart-001" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Welcome demo",
    "aspect_ratio": "16:9",
    "quality": "Balanced",
    "storyboard": [],
    "tracks": {"visual":[],"avatar_voice":[],"music":[],"sfx":[],"captions":[],"text":[]}
  }'
13共 13 节 — 点击跳转
  1. 01AI 视频生成 API 可以做什么
  2. 02在 Replicate 运行 VlogMe Avatar
  3. 03身份验证
  4. 04快速开始
  5. 05REST 接口
  6. 06创建 AI 视频
  7. 07脚本语法
  8. 08Webhook
  9. 09MCP 服务器
  10. 10MCP 客户端配置
  11. 11AI 智能体完整示例
  12. 12智能体 Skill
  13. 13错误与重试
01
概览

AI 视频生成 API 可以做什么

通过程序创建 AI 视频项目与口播数字人,并与网页端共用账户、积分和任务记录。

后端服务、自动化和产品集成可使用 REST;需要 AI 智能体自行发现工具、估算费用并提交任务时可使用 MCP。

公开 v1 API 为异步模式:保存任务 ID,通过轮询或签名 Webhook 获取结果。生成需要足够积分覆盖精确预留。

  • 扣除积分前先估算费用。
  • 用人物照片、文字与声音,或直接用录音生成口播视频。
  • 读取进度并获取有时效的签名下载链接。
  • 使用 Idempotency-Key 安全重试付费请求。
02
托管模型

在 Replicate 运行 VlogMe Avatar

如果只需要“图片 + 音频”端点,也可以使用托管在 Replicate 的公开 VlogMe Avatar bridge。

适合已经通过 Replicate 管理基础设施与计费的项目。积分、历史、REST 与 MCP 等完整能力仍通过 VlogMe API 提供。

托管 bridge 返回竖屏口播数字人 MP4,并默认开启字幕。

03
配置

身份验证

每个受保护请求都需要 Bearer token。Token 只在创建时显示一次,请保存到密钥管理服务。

在 Settings → API 中创建。不要把 Token 放入浏览器代码、移动应用包、公开仓库或客户端日志。

REST 基础地址为 https://vlogme.ai/api/v2。如可能泄露,请立即轮换。

http
Authorization: Bearer vlm_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
url
https://vlogme.ai/api/v2
04
开始

快速开始

创建 Token、估算请求、提交生成,并持续查询直到任务进入终态。

示例会发送人物照片 URL、脚本、voice_id 和画面比例。请替换为 VlogMe 服务器可访问的素材。

POST 成功后立即返回 202 Accepted。可每约十秒轮询一次,也可传入 webhook_url。

bash
curl -X POST https://vlogme.ai/api/v2/renders \
  -H "Authorization: Bearer $VLOGME_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "project_id": "PROJECT_UUID",
    "revision_id": "REVISION_UUID",
    "preset": "balanced",
    "idempotency_key": "video-request-001"
  }'
05
REST

REST 接口

简洁的 JSON API,提供 OpenAPI 3.1、稳定错误码与限流响应头。

机器可读规范位于 /api/v2/openapi.json,可生成类型化客户端或导入 Postman、Insomnia。

所有响应包含 X-Request-Id;异步 POST /videos 还会在 Location 中返回轮询地址。

GET/projects用户 ID、套餐与积分余额
POST/projects可用于语音合成的 voice_id
GET/projects/:id启动异步生成任务
PATCH/projects/:id读取状态与签名下载链接
POST/renders分页获取最近生成记录
GET/jobs/:id不扣费估算所需积分
POST/jobs/:id/cancel删除或取消符合条件的任务
POST/projects/:id/director-proposals无需认证的服务存活检查
bash
curl https://vlogme.ai/api/v2/jobs/$JOB_ID \
  -H "Authorization: Bearer $VLOGME_TOKEN"
06
REST

创建 AI 视频

提供人物照片,以及 script + voice_id 或音频素材。视频生成会异步执行。

照片使用 portrait_url 或 portrait_base64。语音可用 script + voice_id,或 audio_url/audio_base64。可选字段包括 aspect_ratio、emotion_preset、live_subtitles、title 与 webhook_url。

每个付费 POST 必须包含唯一 Idempotency-Key。使用相同 Key 重试会返回原任务,不会重复扣费。

  • 画面比例:默认 9:16,也支持 16:9 与 1:1。
  • 顶层 inserts 可添加 overlay 或 cut 模式的 B-roll。
  • 项目背景音 audio_mode 可设为 auto、prompt、asset 或 off。
  • 202 响应包含 id、status、credits_charged、estimated_seconds 与 warnings。
bash
curl -X POST https://vlogme.ai/api/v2/renders \
  -H "Authorization: Bearer $VLOGME_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "project_id": "PROJECT_UUID",
    "revision_id": "REVISION_UUID",
    "preset": "balanced",
    "idempotency_key": "video-request-001"
  }'
07
脚本

脚本语法

机器可读 DSL 用于描述场景切换、B-roll、音频插入、停顿和声音表演标签。

使用 @imageN 切换说话场景,花括号表示 overlay/chain B-roll,@audioN 插入音频,并可使用 [shocked] 等 ElevenLabs 表演标签。

下载规范保留供工具与 LLM 使用的契约语言。MCP 客户端也可通过 script_grammar_help 读取同一规范。

下载 .md打开原始规范
SCRIPT-GRAMMAR.md
# V2 script grammar compatibility

This document describes the supported V2 plain-text import grammar. Current
Create authoring uses typed `CreateSnapshot` revisions and does not serialize
its editor state through this grammar.

The V2 bridge `flatToPayloads()` converts the grammar into `ScenePayload[]`.
Provider-specific payloads are derived later by render and integration
infrastructure; the browser never constructs them.

## Forms

| Form                   | Meaning                                    |
| ---------------------- | ------------------------------------------ |
| `@imageN <text>`       | Avatar speech anchored to image N          |
| `@imageN { <prompt> }` | Standalone generated video from image N    |
| `{ @imageN <prompt> }` | Overlay on the current avatar              |
| `{ <prompt> }`         | Continue from the preceding rendered frame |
| `@audioN`              | Uploaded audio on the current avatar       |

Plain text following an avatar line continues that avatar's speech. Video,
overlay and Continue forms may add `:D` after the closing brace to request a
duration. Advanced brace segments support `v:`, `n:`, `s:`, `an:`,
`am:auto|prompt|asset|off`, `ag:` and transition `tK`.

Whitespace and indentation do not change token meaning. Tags must begin a line
or appear at the start of a brace body; nested braces and inline image tags in
speech are invalid. Provider-specific prompt and duration limits are validated
before submission.

Legacy bare image lines remain parser-compatible for existing V2 projects, but
new generated V2 scripts should use the explicit forms above.

## Create boundary

Create visual blocks carry their own typed `visual_kind`, entry source,
timeline placement and media plan. In particular, Create Continue is an
independent visual block with `entry.mode = previous_exit`, an explicit
predecessor and the predecessor's accepted terminal-frame fingerprint. It is
not derived from the V2 brace syntax.
08
REST

Webhook

传入 webhook_url 后,VlogMe 会在完成或失败时发送事件,并对暂时性投递失败进行重试。

使用 Settings → API 中独立的 whsec_ 密钥,按 timestamp + raw_body 验证 X-Vlogme-Signature。拒绝超过五分钟的时间戳,并按 X-Vlogme-Event-Id 去重。

请在五秒内返回任意 2xx。网络错误与 5xx 会退避重试,4xx 视为永久拒绝。若签名链接过期,请重新 GET 视频。

python
ts = request.headers["X-Vlogme-Timestamp"]
secret = "whsec_..."  # Settings -> API
expected = "sha256=" + hmac_sha256(secret, ts + "." + raw_body).hex()
assert constant_time_eq(expected, request.headers["X-Vlogme-Signature"])
assert abs(now() - int(ts)) < 300
09
MCP

MCP 服务器

使用 VlogMe Token 或交互式 OAuth,通过原生 Streamable HTTP 连接 AI 智能体。

MCP 工具是 REST v1 的轻量封装,共用数据结构、积分公式与稳定错误码。更新只会新增字段,客户端应忽略未知字段。

工具覆盖声音、余额、估算、人物图、生成、状态、取消和历史。获得授权的内部账户还可处理工作项。

endpoint
POST  https://mcp.vlogme.ai/api/mcp
script_grammar_helplist_voicesget_balanceestimate_creditslist_portraitsgenerate_videoget_videocancel_videolist_my_videoslist_bugsget_bugreport_bugupdate_bug_status
10
MCP

MCP 客户端配置

Claude Code、Cursor 与 Codex 支持 Streamable HTTP;旧版 stdio 客户端可使用 mcp-remote。

只选择一种认证方式:交互式 OAuth 或环境变量中的 API Token,不要混用。

修改 MCP 配置后,请启动新的客户端会话,以重新发现工具。

bash
# OAuth
codex mcp add vlogme --url https://mcp.vlogme.ai/api/mcp
codex mcp login vlogme --scopes mcp:full,mcp:work_items

# or API token
export VLOGME_TOKEN=vlm_live_xxxxxxxxxxxx
codex mcp add vlogme --url https://mcp.vlogme.ai/api/mcp --bearer-token-env-var VLOGME_TOKEN
json
{
  "mcpServers": {
    "vlogme": {
      "url": "https://mcp.vlogme.ai/api/mcp",
      "headers": { "Authorization": "Bearer YOUR_TOKEN_HERE" }
    }
  }
}
11
MCP

AI 智能体完整示例

自然语言需求会转换成一组可见、可审计的工具调用。

智能体可以依次查询声音、估算费用、请求确认、调用 generate_video,并用 get_video 监控到终态。

仍需提供可访问的人物照片与足够积分。MCP 和 REST 使用相同的令牌范围、所有权、到期时间与每用户速率限制。

prompt
Create a 16:9 talking-avatar video from this portrait.
Use a warm, natural voice. Estimate the credits first and ask before generating.
After approval, monitor the job and return the final download URL.
12
智能体

智能体 Skill

通过简短操作规范,让智能体先估算、请求确认,并正确处理异步任务状态。

说明何时使用 VlogMe、调用顺序、如何维持幂等性,以及何时停止轮询。

不要把真实 Token 写入 Skill 文件,应保存在客户端环境或 OAuth 存储中。

markdown
---
name: vlogme-video
description: Estimate and generate VlogMe video jobs through MCP.
---
1. Validate the portrait and requested format.
2. Call estimate_credits before generation.
3. Ask for approval with the estimate.
4. Use a stable idempotency key for transport retries.
5. Poll get_video until a terminal status.
13
参考

错误与重试

错误格式为 { error: { code, message } }。程序应根据稳定 code 分支,而不是依赖会翻译的 message。

联系支持时提供 X-Request-Id。429 会包含 Retry-After;认证与输入错误应先修正,不要无条件重试。

OpenAPI 包含完整结构和错误列表。成功响应会返回限流的 limit、remaining 与 reset。

codeHTTP
missing_token401
invalid_token401
token_expired401
insufficient_credits402
invalid_input400
invalid_asset400
invalid_json400
not_found404
method_not_allowed405
already_started409
billing_conflict409
rate_limited429
internal_error500
Worth to Know

开发者 常见问题

任何需要程序化生成会说话的虚拟形象视频的应用程序:个性化销售视频、AI导师、新闻主播、产品说明、NPC对话、大规模本地化配音。一个POST请求将肖像URL + 脚本 + 语音ID作为输入,并返回一个完成的MP4。

Vlogme在/api/mcp处公开了一个可流式传输的HTTP MCP端点。使用此页面上的CLI代码片段添加一次,您的代理即可原生调用list_voices、generate_video和get_video——无需胶水代码,也无需额外的SDK。

与网页应用相同:每完成一秒视频约1个积分,最少10个。当您POST /videos时扣除积分,如果渲染失败或在完成之前删除,则自动退款。

API 请求采用每用户速率限制。请读取成功响应中的 X-RateLimit 标头,并在收到 429 后遵守 Retry-After。

支持。每个webhook都包含一个X-Vlogme-Signature标头(原始主体的sha256 HMAC,您的令牌作为密钥)。失败的交付将以指数退避的方式重试24小时。

任何经过身份验证的令牌所有者都可以使用 API 和 MCP。生成使用与网页应用相同的积分余额、估算、预留、范围和速率限制。