API RapidVideoMaker
REST API 允许从任何 HTTP 客户端处理视频文件——Python 脚本、n8n 工作流、第三方工具。五种模式:合并视频(多个 MP4)、编辑音频(1 MP4 + 1 MP3)、创建视频(1 JPG/PNG + 1 MP3)、视频叠加(2 MP4 画中画)。处理为异步:提交文件后轮询结果。
完整工作流程
每个集成都遵循相同的4步序列:
POST /api/v1/render.phpmultipart/form-data发送。1张JPG/PNG图像 + 1个MP3 + mode=image_to_video → 视频生成。1个MP4 + 1个MP3 → 音频编辑。多个MP4 → 合并。服务器返回唯一的job_id。GET /api/v1/jobs.php?job_id=…queued → processing → ready(或error)。ready时,响应包含可用的download_url字段。GET /api/download.php?job_id=…认证
每个请求必须包含您的API令牌。接受两种格式:
您的令牌可在会员区获取 — 每个账户一个令牌,注册时自动创建。
配额
每个会员账户有每天20个请求,在网页界面和API之间共享。失败的任务不消耗配额。计数器在UTC午夜重置。
POST响应包含quota_used和quota_remaining。超过限制时,服务器响应429。
队列
一次处理一个任务。如果同时提交多个任务,它们会排队按顺序处理。等待时,状态响应包含:
queue_position— 任务在队列中的位置(1 = 下一个处理)queue_total— 等待中的任务总数eta_minutes— 处理开始前的预估时间
/api/v1/jobs.php端点每个令牌最多接受每分钟12次调用。建议:调用间隔10秒。 可用转场效果
直接合并传入transition_type=none(默认),或使用以下类型之一在剪辑间淡入淡出:
时长(transition_duration)在0.2到2.0秒之间。
端点
五种模式,通过 mode 字段指定(多个 MP4 省略 mode 自动检测 fusion):
| 用法 | API模式 | 所需文件 | 描述 |
|---|---|---|---|
| 合并视频 | fusion |
2-20个MP4文件 | 剪辑按提供的顺序首尾相连组装。剪辑之间可选择性添加转场效果。 |
| 编辑音频 | add_audio 或 mix_audio |
1个MP4 + 1个MP3 | 替换或丰富视频的音轨。视频轨道永不重新编码。add_audio — 原始音频被删除并完全替换为MP3。mix_audio — 原始音频被保留,MP3被叠加。 |
| 创建视频 | image_to_video |
1张JPG/PNG + 1个MP3 | 从静态图像和音频文件生成视频。文本叠加、淡入淡出、分辨率和fps可通过options字段配置。 |
| 视频叠加 | overlay_video |
2 MP4 | 将第二个视频叠加在主视频上方。位置、大小、透明度和音频可通过 options 字段配置。 |
| 文字转MP3 | text_to_mp3 |
(仅文本) | 将文本转换为语音并返回MP3文件。无需上传文件 — 将 mode=text_to_mp3、text 和 lang 作为表单字段发送。支持网站的全部20种语言。 |
add_audio和mix_audio只接受1个MP4 + 1个MP3。image_to_video只接受1张JPG/PNG + 1个MP3。公共参数(multipart/form-data)
| 字段 | 类型 | 必填 | 描述 |
|---|---|---|---|
| videos[] | File[] | 是 | 要处理的文件。根据模式不同:2-20个MP4,或1个MP4 + 1个MP3,或1张图像(JPG/PNG)+ 1个MP3。每个文件最大500 MB。 |
| mode | string | * | image_to_video | add_audio | mix_audio。这三种模式必填。仅当所有文件均为MP4时忽略(fusion)。 |
| order | JSON | 仅限fusion模式 — 定义剪辑顺序的索引JSON数组。 | |
| transition_type | string | 仅限fusion模式。默认:none。 | |
| transition_duration | float | 仅限fusion模式。时长0.2-2.0秒。默认:0.5。 | |
| options | JSON | 仅限image_to_video模式 — 渲染参数的JSON对象。 | |
| callback_url | string | 任务完成时调用的公共URL(http/https)。响应包含webhook_secret。 |
options参数 — image_to_video模式
全部可选。未提供的值 → 由工作进程应用默认值。
| 键 | 类型 | 默认值 | 描述 |
|---|---|---|---|
| text | string | "" | 作为叠加显示的文本。空 = 无文本。最多500个字符。 |
| font_size | int | 60 | 字体大小(像素)。范围:10-300。 |
| text_color | string | "white" | 文本颜色(例如:white、yellow、#ffffff)。 |
| text_position | string | "center" | 文本位置:center、top、bottom。 |
| box | bool | true | 文本后面的半透明背景。 |
| box_color | string | "black@0.4" | FFmpeg格式的颜色 + 不透明度:color@opacity。 |
| fade_duration | float | 0.5 | 淡入/淡出时长(秒),0-2。0 = 无效果。 |
| width | int | 1080 | 视频宽度(像素),64-3840,强制为偶数。 |
| height | int | 1920 | 视频高度(像素),64-3840,强制为偶数。 |
| fps | int | 24 | 帧率(1-60)。 |
| image_fit | string | "contain" | 取景模式:contain = 显示完整图像;cover = 缩放以填满整个画面。 |
| bg_color | string | "black" | 图像未填满目标分辨率时的背景颜色。 |
| enable_image_motion | bool | false | 启用照片动画。false时图像保持静态。 |
| image_motion_effect | string | "ken_burns" | 动画效果。接受的值:zoom_in、zoom_out、pan_left_to_right、ken_burns等。 |
| motion_intensity | float | 1.0 | 照片动画强度(0.25-2.0)。乘以缩放幅度和平移速度。 |
| text_effect | string | "none" | 文本叠加动画。接受的值:none、fade_in、slide_up、bounce。 |
| text_effect_intensity | float | 1.0 | 文本动画强度(0.25-2.0)。text_effect为none时忽略。 |
| text_border_width | int | 0 | 字符周围黑色轮廓的厚度(像素),0 = 禁用。 |
| text_mode | string | "static" | 文字显示模式。static(默认):从第一帧起显示全文。word_by_word:按 word_reveal_speed 的速率逐词显示。与 text_effect 互斥:若 text_mode=word_by_word,则 text_effect 将被忽略。 |
| word_reveal_speed | float | 1.5 | 逐词显示速度,单位为词/秒(0.3–5.0,默认 1.5)。仅在 text_mode=word_by_word 时使用。与 OpenAI TTS 同步的推荐值:2.0。 |
| word_anim | string | "none" | 每个单词出现的动画。none(默认):即时显示。fade:每个新单词以0.2秒淡入并与前一块交叉淡化。仅在 text_mode=word_by_word 时有效。 |
options 参数 — overlay_video 模式
均为可选。上传顺序很重要:第一个文件是主视频(背景),第二个文件是叠加视频(前景)。使用 chroma_key 可去除叠加视频的绿幕背景。
| 键 | 类型 | 默认值 | 描述 |
|---|---|---|---|
| position | string | "bottom-right" | 叠加视频的放置位置:top-left、top-right、bottom-left、bottom-right 或 center。 |
| scale | float | 0.30 | 叠加视频宽度占主视频宽度的比例。0.25 = 25%。范围:0.05–1.0。 |
| opacity | float | 1.0 | 叠加视频的透明度。1.0 = 完全不透明,0.0 = 不可见。 |
| margin | int | 10 | 叠加视频与画面边缘的像素距离。当 position=center 时忽略。范围:0–200。 |
| audio | string | "main" | 保留哪条音轨。main:仅主视频音频。overlay:仅叠加视频音频。mix:两者混合。 |
| chroma_key | bool | false | 设为 true 可去除叠加视频的纯绿色(#00FF00)背景 — 适用于绿幕前拍摄的摄像头或动画。 |
| chroma_similarity | float | 0.20 | 绿幕容差。低 = 严格匹配(保留主体边缘)。高 = 更宽泛的去除(适应光线不均)。推荐:数字绿 0.10–0.20,物理屏幕 0.25–0.45。范围:0.01–0.60。 |
options参数 — 音频编辑(mix_audio)
仅在mode=mix_audio时可用。add_audio时忽略。
| 键 | 类型 | 默认值 | 描述 |
|---|---|---|---|
| mp3_volume | float | 1.0 | 叠加MP3的音量(0.0 = 静音,1.0 = 原始音量,2.0 = 双倍)。 |
成功响应(HTTP 200)
curl示例 — image_to_video模式
curl示例 — 音频编辑
curl 示例 — overlay_video 模式
curl示例 — 视频合并
可能的状态
| 状态 | 含义 | 额外字段 |
|---|---|---|
| queued | 在队列中,尚未处理 | queue_position, queue_total, eta_minutes |
| processing | FFmpeg处理中 | — |
| ready | 已完成 — 文件可用 | download_url, created_at, expires_at |
| error | 处理失败 | error (message) |
按状态的响应
curl示例
公共参数(multipart/form-data)
| apidocs_th_param | 类型 | 默认值 | apidocs_th_desc |
|---|---|---|---|
page | integer | 1 | Page number (starts at 1) |
limit | integer | 20 | Results per page (max 50, default 20) |
按状态的响应
将已完成的 job(status=ready)发布到一个或多个社交账户。Token 必须属于会员账户(不是管理员 token)。
account_id 在该页面显示。公共参数(multipart/form-data)
| apidocs_th_param | 类型 | apidocs_th_required | apidocs_th_desc |
|---|---|---|---|
job_id | string | apidocs_required | 已完成视频的 job ID(hex 32 位字符) |
publications | array | apidocs_required | 发布对象数组(最多 10 个) |
发布对象
| apidocs_th_param | 类型 | apidocs_th_required | apidocs_th_desc |
|---|---|---|---|
account_id | integer | apidocs_required | 已连接社交账号的 ID — 在会员区发布页面中查看 |
title | string | — | 视频标题(最多 512 个字符) |
description | string | — | 视频描述(最多 5 000 个字符) |
tags | string | — | 逗号分隔的标签(最多 1 024 个字符) |
visibility | string | — | public | private | unlisted — 默认:public |
tiktok_mode | string | — | draft | direct — 仅 TikTok — 默认:direct |
tiktok_privacy | string | direct 模式 | 仅 TikTok — direct 模式下必填 |
allow_comment | boolean | — | 仅 TikTok — 允许评论 |
allow_duet | boolean | — | 仅 TikTok — 允许合拍 |
allow_stitch | boolean | — | 仅 TikTok — 允许拼接 |
your_brand | boolean | — | 仅 TikTok — 有机推广内容("您的品牌")。 |
branded_content | boolean | — | 仅 TikTok — 品牌内容披露 |
tiktok_cover_ms | integer | — | 仅 TikTok — 封面帧时间戳(毫秒,0–60 000,默认 1 000) |
按状态的响应
每条发布的错误代码
| apidocs_th_code | 含义 |
|---|---|
job_not_ready | job 尚未完成 |
mode_not_supported | text_to_mp3 job 无法发布 |
account_not_found | 账户未找到或已断开连接 |
tiktok_privacy_required | direct 模式需要隐私级别 |
publication_failed | 上传过程中提供商返回了错误 |
cURL 示例
以流的形式返回最终MP4文件(Content-Type: video/mp4)。不需要令牌。仅在状态为ready时可用。
文件在任务完成后保留2小时,然后删除。状态变为ready后请立即下载。
可选参数
| 参数 | 描述 |
|---|---|
| filename | 下载文件的建议名称(例如:my-video.mp4) |
curl示例
Webhooks
Webhook是轮询的替代方案:不是每隔X秒检查状态,而是提供URL,服务器在任务完成时自动通知您。
工作原理
- 在POST到
/api/v1/render.php时传入callback_url - 响应包含
webhook_secret— 保存它以验证签名 - 当任务达到
ready或error时,服务器向您的URL发送签名的JSONPOST - 使用
HMAC-SHA256(webhook_secret, raw_body)验证签名
callback_url必须是可公开访问的URL(http或https)。私有、回环和保留IP地址在服务器端被阻止。超时:10秒。 接收到的有效载荷
服务器发送的标头
| 标头 | 值 |
|---|---|
| Content-Type | application/json |
| X-RVM-Signature | sha256=<hmac_hex> — 原始主体的HMAC-SHA256签名 |
| X-RVM-Job-Id | 相关的job_id |
签名验证
错误代码
| HTTP | JSON代码 | 原因 |
|---|---|---|
| 401 | unauthorized | 令牌缺失、无效或已撤销 |
| 400 | missing_files | 未收到文件 |
| 400 | too_few_files | 发送的文件少于2个 |
| 400 | too_many_files | 发送的文件超过20个 |
| 400 | invalid_mime | 不支持的文件 — 仅接受MP4、MP3和JPG/PNG |
| 400 | wrong_file_count | 文件数量与所选模式不匹配 |
| 400 | wrong_file_types | 文件类型与所选模式不匹配 |
| 400 | invalid_file_combination | 没有指定模式的文件组合不匹配任何支持的模式 |
| 400 | invalid_options | options字段不是有效的JSON |
| 400 | invalid_option | options中的某个值无效 |
| 400 | file_too_large | 文件超过500 MB |
| 400 | invalid_order | order数组不是有效的排列 |
| 400 | invalid_job_id | job_id格式不正确(必须是32个字符的十六进制) |
| 404 | job_not_found | 未找到任务 — job_id未知或从未存在 |
| 410 | job_expired | 任务已过期 — 曾经存在但2小时恢复窗口已过 |
| 429 | quota_exceeded | 已达到每天20个成功任务的限制 |
| 429 | rate_limited | /api/v1/jobs.php每分钟超过12次调用 |
| 500 | server_error | 内部服务器错误 |
集成示例
各模式示例 — 使用pip install requests安装requests。
公共配置
image_to_video模式 — 图像 + 音频 → 视频
音频编辑
overlay_video 模式 — 画中画
视频合并
轮询 + 下载(所有模式通用)
n8n中的两种方法:轮询(状态循环)或Webhook(服务器调用n8n)。推荐Webhook。
方法A — Webhook(推荐)
仅3个节点,无循环。
节点1 — Webhook触发器
添加Webhook节点作为工作流输入(方法POST)。
节点2 — 创建任务(HTTP请求)
| 方法 | POST |
| URL | https://rapidvideomaker.com/api/v1/render.php |
| 认证 | Header Auth — Authorization: Bearer rvm_… |
| 请求体内容类型 | Form-Data Multipart |
| Body params | 每个剪辑的二进制字段videos[] + 文本字段callback_url |
将响应中的webhook_secret保存在工作流变量中以验证签名。
节点3 — 处理结果(在Webhook触发的工作流中)
当n8n收到服务器的POST时,$json.status为ready或error。
{{ $headers['x-rvm-signature'] }}与您的webhook_secret的HMAC-SHA256进行比较。方法B — 轮询(无Webhook)
5个节点,每10秒状态循环。
节点1 — 创建任务 — 同上配置,无callback_url。
节点2 — 等待 — 10秒。
节点3 — 轮询状态(HTTP请求GET)
| URL | https://rapidvideomaker.com/api/v1/jobs.php |
| 查询参数 | job_id = {{ $('节点1').item.json.job_id }} |
| 认证 | 标头认证 — 相同令牌 |
节点4 — If:{{ $json.status }} === 'ready' → true:节点5 / false:返回节点2。
节点5 — 下载:在{{ $json.download_url }}上发起HTTP请求GET。
步骤1 — 创建任务(选择模式)
步骤2 — 轮询
步骤3 — 下载
最佳实践
- 轮询频率:
/api/v1/jobs.php端点每个令牌限制12次/分钟。调用间隔至少5秒。 - 超时:实现客户端超时(例如:10分钟)。
- 快速下载:状态变为
ready时立即下载。任务完成后2小时删除。 - 配额管理:检查POST响应中的
quota_remaining。 - 网络错误:轮询过程中出现网络错误时,等待并重试。