GET_DRAFT API 接口文档
接口信息
- 请求方式: GET
- 接口地址:
/openapi/capcut-tools/v1/get_draft
功能描述
获取草稿文件列表。该接口用于获取指定草稿 ID 对应的所有文件列表,可以查看草稿中包含的素材文件、配置文件等信息。通常用于草稿内容的预览、文件管理或状态检查。
更多文档: 📖 速创 AIGC-工具平台官方文档
请求参数
Query 参数
| 参数名 |
类型 |
必填 |
默认值 |
说明 |
| draft_id |
string |
✅ |
- |
草稿 ID,长度为 20-32 位字符 |
参数详解
draft_id
- 类型: 字符串
- 必填: 是
- 长度: 20-32 位字符
- 格式: 通常为 UUID 格式或类似的唯一标识符
- 示例:
2f52a63b-8c6a-4417-8b01-1b2a569ccb6c
- 获取方式: 通常从 draft_url 中提取或由 create_draft 接口返回
响应格式
成功响应 (200)
{
"files": [
"2f52a63b-8c6a-4417-8b01-1b2a569ccb6c.json",
"video_123456789.mp4",
"audio_987654321.mp3",
"image_555666777.jpg",
"thumbnail_888999000.png"
]
}
响应字段说明
| 字段名 |
类型 |
说明 |
| files |
array |
草稿相关的文件列表 |
错误响应 (4xx/5xx)
{
"detail": "错误信息描述"
}
使用示例
cURL 示例
1. 基本获取草稿文件列表
curl -X GET "https://agent.aigc-ai.com/openapi/capcut-tools/v1/get_draft?draft_id=2f52a63b-8c6a-4417-8b01-1b2a569ccb6c" \
-H "Content-Type: application/json"
2. 使用完整的 draft_id
curl -X GET "https://agent.aigc-ai.com/openapi/capcut-tools/v1/get_draft?draft_id=7e8f9a0b-1c2d-3e4f-5g6h-7i8j9k0l1m2n" \
-H "Content-Type: application/json"
错误码说明
| 错误码 |
错误信息 |
说明 |
解决方案 |
| 400 |
draft_id 是必填项 |
缺少 draft_id 参数 |
提供有效的 draft_id |
| 400 |
draft_id 长度无效 |
draft_id 长度不在 20-32 位范围内 |
检查 draft_id 格式是否正确 |
| 400 |
draft_id 格式无效 |
draft_id 格式不正确 |
确保使用正确的草稿 ID 格式 |
| 404 |
草稿不存在 |
指定的草稿 ID 无法找到 |
确认草稿 ID 是否正确且存在 |
| 500 |
获取文件列表失败 |
内部服务错误 |
联系技术支持或稍后重试 |
| 503 |
服务不可用 |
系统维护中 |
稍后重试 |
注意事项
- 参数格式: 确保 draft_id 格式正确且长度在 20-32 位之间
- ID 提取: 从 draft_url 正确提取 draft_id
- 文件类型: 返回的文件列表包含多种类型的文件
- 权限验证: 确保有权限访问指定的草稿
- 实时性: 文件列表可能不是实时更新的,存在一定延迟
- 文件状态: 列表中的文件可能处于不同的处理状态
工作流程
- 验证 draft_id 参数
- 检查 draft_id 格式和长度
- 查找指定的草稿
- 获取草稿关联的所有文件
- 返回文件列表
相关接口
- 创建草稿
- 保存草稿
- 添加视频
- 添加音频
- 添加图片
- 生成视频