CapCut Mate API 文档 #

📖 项目简介 #

CapCut Mate API 是一个基于 FastAPI 构建的剪映小助手，为开发者提供强大的视频编辑自动化能力。通过 RESTful API 接口，您可以轻松创建、编辑和渲染视频内容，无需手动操作剪映软件。

🔗 项目地址: GitHub | Gitee

📑 目录 #

• 📖 项目简介
• ✨ 核心功能
• 🚀 快速开始
• 📚 API 接口文档
• 🏗️ 系统架构
• 🔄 典型工作流程
• 📊 API 使用统计
• ⚡ 性能优化
• 🔧 更多文档
• 💬 技术支持
• 📄 许可证

✨ 核心功能 #

🎬 视频制作流程 #

• 草稿管理：创建、保存、获取草稿信息
• 素材添加：支持视频、音频、图片、贴纸等多种素材
• 文本处理：添加字幕、文本样式、关键词高亮
• 特效应用：视觉特效、动画、转场、遮罩效果
• 视频渲染：云端生成最终视频文件

🔧 技术特性 #

• 高性能：基于 FastAPI 构建，支持异步处理
• 类型安全：使用 Pydantic 进行数据验证
• 标准化：符合 RESTful API 设计规范
• 自动文档：集成 Swagger UI 交互式文档
• 容器化：支持 Docker 部署

🚀 快速开始 #

环境准备 #

在开始使用 CapCut Mate API 之前，请确保您具备以下条件：

• 🌐 网络环境: 能够访问 API 服务地址
• 🔑 API 权限: 已获得相应的 API 访问权限
• 📚 开发环境: 支持 HTTP 请求的开发环境

📋 API 调用流程 #

CapCut Mate API 的典型使用流程如下：

graph TD
    A[创建草稿] --> B[添加视频素材]
    B --> C[添加音频素材]
    C --> D[添加字幕]
    D --> E[添加特效]
    E --> F[生成视频]
    F --> G[保存草稿]

💻 快速示例 #

Python 示例 #

import requests
import json

# 1. 创建草稿
def create_draft():
    url = "https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/create_draft"
    payload = {
        "aspect_ratio": 1,  # 16:9 横屏
        "duration": 60000000  # 60秒
    }
    
    response = requests.post(url, json=payload)
    return response.json()

# 2. 添加视频
result = create_draft()
draft_url = result["data"]["draft_url"]

# 继续添加其他素材...
print(f"草稿创建成功: {draft_url}")

JavaScript 示例 #

// 创建草稿
async function createDraft() {
  const response = await fetch('https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/create_draft', {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({
      aspect_ratio: 1,
      duration: 60000000
    })
  });
  
  const result = await response.json();
  return result.data.draft_url;
}

// 使用示例
createDraft().then(draftUrl => {
  console.log('草稿创建成功:', draftUrl);
  // 继续添加其他素材...
});

📚 API 接口文档 #

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

🏗️ 草稿管理 #

🎥 视频素材 #

🎵 音频处理 #

📝 文本字幕 #

✨ 特效动画 #

🎨 动画资源 #

🎬 视频生成 #

🚀 快速工具 #

🔗 快速导航 #

🏗️ 系统架构 #

分层设计 #

┌─────────────────┐
│   FastAPI App   │  HTTP API 层
├─────────────────┤
│   Middlewares   │  中间件层（请求预处理、响应格式化）
├─────────────────┤
│   Router (v1)   │  路由层（接口定义、参数验证）
├─────────────────┤
│   Service       │  业务逻辑层（核心功能实现）
├─────────────────┤
│ pyJianYingDraft │  剪映草稿处理层（草稿文件操作）
├─────────────────┤
│     Utils       │  工具层（缓存、日志、任务管理）
└─────────────────┘

核心模块 #

• Router: API 路由定义和请求处理
• Service: 业务逻辑实现和数据处理
• pyJianYingDraft: 剪映草稿文件的创建和编辑
• Schemas: 数据模型定义和验证
• Utils: 缓存管理、日志记录、任务调度

🔄 典型工作流程 #

基础视频制作流程 #

graph LR
    A[创建草稿] --> B[添加视频素材]
    B --> C[添加音频背景]
    C --> D[添加字幕文本]
    D --> E[应用特效动画]
    E --> F[保存草稿]
    F --> G[生成视频]
    G --> H[查询状态]
    H --> I[获取结果]

进阶制作流程 #

graph TB
    A[创建草稿] --> B[批量添加素材]
    B --> C[easy_create_material]
    C --> D[精细调整]
    D --> E[添加关键帧动画]
    E --> F[应用遮罩效果]
    F --> G[添加转场特效]
    G --> H[保存并渲染]

📊 API 使用统计 #

接口分类 #

• 草稿管理: 3 个接口
• 素材添加: 6 个接口
• 特效动画: 5 个接口
• 视频生成: 2 个接口
• 辅助工具: 2 个接口

常用组合 #

1. 快速制作: create_draft → easy_create_material → gen_video
2. 精细编辑: create_draft → add_videos → add_audios → add_captions → add_effects → gen_video
3. 动画制作: create_draft → add_images → add_keyframes → add_masks → gen_video

⚡ 性能优化 #

建议实践 #

• 批量操作: 尽量使用批量接口减少请求次数
• 异步处理: 视频生成使用异步任务，避免长时间等待
• 缓存机制: 草稿信息支持缓存，提高访问速度
• 错误重试: 网络请求失败时自动重试
• 资源预检: 使用 get_audio_duration 等接口预检资源

限制说明 #

• 并发限制: 避免同时处理过多视频生成任务
• 文件大小: 建议单个素材文件不超过 100MB
• 时长限制: 建议单个视频时长不超过 10 分钟
• 请求频率: 建议控制请求频率，避免服务器过载

🔧 更多文档 #

📖 更多详细文档和教程请访问：https://docs.jcaigc.cn

💬 技术支持 #

获取帮助 #

• 📖 交互式文档: 访问 http://localhost:60000/docs 查看 Swagger UI
• 🐛 问题反馈: 提交 GitHub Issues 或 Gitee Issues
• 📧 商业合作: 联系邮箱 taohongmin51@gmail.com
• 💬 社区讨论: 欢迎提交 Pull Request 来改进项目

贡献指南 #

欢迎提交 Pull Request 来改进项目：

1. 🍴 Fork 项目
2. 🌿 创建功能分支
3. 📝 提交更改
4. 🚀 创建 Pull Request

开源地址 #

📄 许可证 #

本项目采用 MIT 许可证，详情请查看 LICENSE 文件。