Skip to content

开源剪映小助手|剪映API | 扣子插件 | Open-source CapCut automation toolkit to generate & download draft files.

License

Notifications You must be signed in to change notification settings

Hommy-master/capcut-mate

Repository files navigation

CapCut Mate API

项目简介

CapCut Mate API 是一个基于 FastAPI 构建的剪映草稿自动化助手,提供丰富的API接口来创建和编辑剪映草稿。支持创建草稿、添加视频/音频/图片/字幕/特效等素材、保存草稿及云端渲染等功能,可作为扣子插件一键部署使用。

项目相关资源

⭐ 如果您觉得这个项目对您有点帮助,麻烦点个 Star 支持一下!您的支持是我持续维护和改进项目的最大动力 😊

功能特点

  • 🎬 草稿管理:创建草稿、获取草稿、保存草稿
  • 🎥 素材添加:添加视频、音频、图片、贴纸、字幕、特效、遮罩等
  • 🔧 高级功能:关键帧控制、文字样式、动画效果等
  • 📤 视频导出:云端渲染生成最终视频
  • 🛡️ 数据验证:使用 Pydantic 进行请求数据验证
  • 📖 RESTful API:符合标准的 API 设计规范
  • 📚 自动文档:FastAPI 自动生成交互式 API 文档

技术栈

  • Python 3.11+
  • FastAPI:高性能的 Web 框架
  • Pydantic:数据验证和模型定义
  • Passlib:密码加密(如果使用用户认证)
  • Uvicorn:ASGI 服务器
  • uv:Python 包管理器和项目管理工具

快速开始

前提条件

  • Python 3.11+
  • uv:Python 包管理器和项目管理工具

安装方法:

Windows

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

Linux/macOS

sh -c "$(curl -LsSf https://astral.sh/uv/install.sh)"

安装步骤

  1. 克隆项目
git clone git@github.com:Hommy-master/capcut-mate.git
cd capcut-mate
  1. 安装依赖
# 安装依赖
uv sync
  1. 启动服务器
uv run main.py
  1. 访问API文档 启动后访问 http://localhost:30000/docs 查看自动生成的交互式API文档

容器部署

docker pull gogoshine/capcut-mate:latest
docker run -p 30000:30000 gogoshine/capcut-mate:latest

或者使用 docker-compose:

docker-compose up -d

一键导入扣子插件

  1. 打开扣子平台:https://coze.cn/home

    步骤1

  2. 添加插件

    步骤2

  3. 导入插件

    步骤3

  4. 上传当前工程目录下的openapi.yaml文件

    步骤4

  5. 完成文件上传

    步骤5

  6. 替换logo完成

    步骤6

  7. 启用插件

    步骤7

API 接口文档

以下是 CapCut Mate API 提供的核心接口,支持完整的视频创作工作流程:

🏗️ 草稿管理

接口 功能 描述 文档链接
create_draft 创建草稿 创建新的剪映草稿项目,设置画布尺寸 📖 查看文档
save_draft 保存草稿 保存当前草稿状态,确保编辑内容持久化 📖 查看文档
get_draft 获取草稿 获取草稿文件列表和详细信息 📖 查看文档

🎥 视频素材

接口 功能 描述 文档链接
add_videos 添加视频 批量添加视频素材,支持裁剪、缩放、特效 📖 查看文档
add_images 添加图片 批量添加图片素材,支持动画和转场效果 📖 查看文档
add_sticker 添加贴纸 添加装饰贴纸,支持位置和大小调整 📖 查看文档

🎵 音频处理

接口 功能 描述 文档链接
add_audios 添加音频 批量添加音频素材,支持音量和淡入淡出 📖 查看文档
get_audio_duration 获取音频时长 获取音频文件的精确时长信息 📖 查看文档

📝 文本字幕

接口 功能 描述 文档链接
add_captions 添加字幕 批量添加字幕,支持关键词高亮和样式设置 📖 查看文档
add_text_style 文本样式 创建富文本样式,支持关键词颜色和字体 📖 查看文档

✨ 特效动画

接口 功能 描述 文档链接
add_effects 添加特效 添加视觉特效,如滤镜、边框、动态效果 📖 查看文档
add_keyframes 关键帧动画 创建位置、缩放、旋转等属性动画 📖 查看文档
add_masks 遮罩效果 添加各种形状遮罩,控制画面可见区域 📖 查看文档

🎨 动画资源

接口 功能 描述 文档链接
get_text_animations 文件动画 获取可用的文本入场、出场、循环动画 📖 查看文档
get_image_animations 图片动画 获取可用的图片动画效果列表 📖 查看文档

🎬 视频生成

接口 功能 描述 文档链接
gen_video 生成视频 提交视频渲染任务,异步处理 📖 查看文档
gen_video_status 查询状态 查询视频生成任务的进度和状态 📖 查看文档

🚀 快速工具

接口 功能 描述 文档链接
easy_create_material 快速创建 一次性添加多种类型素材,简化创建流程 📖 查看文档

API 使用示例

创建草稿

curl -X POST "http://localhost:30000/openapi/capcut-mate/v1/create_draft" \
-H "Content-Type: application/json" \
-d '{"width": 1080, "height": 1920}'

添加视频

curl -X POST "http://localhost:30000/openapi/capcut-mate/v1/add_videos" \
-H "Content-Type: application/json" \
-d '{
  "draft_url": "http://localhost:30000/openapi/capcut-mate/v1/get_draft?draft_id=20251126212753cab03392",
  "video_infos": [
    {
      "url": "https://example.com/video.mp4",
      "start": 0,
      "end": 1000000
    }
  ]
}'

API 文档

剪映小助手客户端

剪映小助手客户端提供了桌面端的便捷操作界面,以下是启动方法:

  1. 安装依赖
# 切换npm镜像源 - 适用于windows
set ELECTRON_MIRROR=https://npmmirror.com/mirrors/electron/

# 切换yarn镜像源 - 适用于linux 或 mac
export ELECTRON_MIRROR="https://npmmirror.com/mirrors/electron/"

# 安装依赖
npm install --verbose
  1. 启动项目
npm run web:dev
npm start

开源社区问题交流群

  • 微信群:

    剪映小助手

商业合作