https://api.apipro.ai| 方法 | 路径 | 说明 |
|---|---|---|
POST | /v1/video/generations | 创建视频生成任务 |
GET | /v1/video/generations/{video_task_id} | 查询任务 |
POST | /volcark/?Action={Action}&Version=2024-01-01 | 素材组、素材和真人认证 |
id是后续查询时使用的任务 ID。| Header | 必填 | 示例值 | 说明 |
|---|---|---|---|
Authorization | 是 | Bearer sk-xxxxx | 平台 API Key |
Content-Type | POST 必填 | application/json | 请求体必须是 JSON object |
https://api.apipro.ai/v1/video/generations
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
model | string | 是 | 模型名,例如doubao-seedance-2.0 |
prompt | string | 是 | 提示词 |
metadata | json | 是 | 视频参数,如:content, resolution, ratio, duration |
{
"prompt": "使用视频1的第一视角构图,生成一个卡通的动画片,最后以图片1作为结尾",
"model": "doubao-seedance-2.0",
"metadata": {
"resolution": "480p",
"ratio": "9:16",
"duration": 6,
"seed": 11,
"camera_fixed": False,
"watermark": False,
"content": [
{
"type": "video_url",
"video_url": {"url": "https://ark-project.tos-cn-beijing.volces.com/doc_video/r2v_tea_video1.mp4"},
"role": "reference_video"
},
{
"type": "image_url",
"image_url": {"url": "https://ark-project.tos-cn-beijing.volces.com/doc_image/r2v_tea_pic1.jpg"},
"role": "reference_image",
}
]
}
}
200{
"id": "tsk\_1234567890abcdef"
}
| 字段 | 类型 | 说明 |
|---|---|---|
id | string | 任务 ID。后续查询、取消 / 删除和 draft 引用都使用该 ID |
{
"id": "tsk\_1234567890abcdef",
"model": "doubao-seedance-2.0",
"status": "succeeded",
"content": \[
{
"type": "video",
"video\_url": "https://example.com/video.mp4"
}
],
"usage": {
"completion\_tokens": 42,
"total\_tokens": 42
}
}
id为创建任务时返回的任务 ID。model为业务方请求的 平台 模型名。status | 说明 |
|---|---|
creating | 创建中 |
submitted | 已提交 |
pending | 排队中(兼容状态) |
queued | 排队中 |
running | 生成中 |
processing | 处理中 |
succeeded | 已完成 |
success | 已完成(兼容状态) |
failed | 失败 |
failure | 失败(兼容状态) |
cancelled | 已取消 |
expired | 已过期 |
| 其他字符串 | 原值透传,不参与状态迁移 |
https://api.apipro.ai/volcark/?Action=CreateAssetGroup&Version=2024-01-01| 类别 | Action | 说明 |
|---|---|---|
| 素材组 | CreateAssetGroup | 创建素材组 |
| 素材组 | ListAssetGroups | 分页查询素材组 |
| 素材组 | GetAssetGroup | 查询素材组 |
| 素材组 | UpdateAssetGroup | 更新素材组名称或描述 |
| 素材组 | DeleteAssetGroup | 删除素材组及其素材 |
| 素材 | CreateAsset | 向素材组上传图像、视频或音频素材 |
| 素材 | ListAssets | 分页查询素材 |
| 素材 | GetAsset | 查询素材及其预处理状态 |
| 素材 | UpdateAsset | 更新素材名称 |
| 素材 | DeleteAsset | 删除素材 |
| 真人认证 | CreateVisualValidateSession | 创建真人认证 H5 会话 |
| 真人认证 | GetVisualValidateResult | 获取认证产生的素材组 ID 或当前认证结果 |
CreateAssetGroup -> CreateAsset -> GetAsset (轮询至 Active) -> 创建 Seedance 任务
{
"Name": "virtual-host",
"Description": "虚拟主持人素材",
"GroupType": "AIGC"
}
GroupId使用CreateAssetGroup返回的素材组 ID,URL必须是可公开访问的素材 URL:{
"GroupId": "<asset\_group\_id>",
"URL": "https://example.com/virtual-host.png",
"AssetType": "Image",
"Name": "正面全身照"
}
CreateAsset成功只表示素材已提交预处理。调用GetAsset,确认Result.Status为Active后,才能在视频创建请求的content中引用它;Processing应继续轮询,Failed时读取Result.Error排障。{
"model": "doubao-seedance-2.0",
"content": \[
{
"type": "text",
"text": "图片 1 中的虚拟主持人面向镜头介绍产品。"
},
{
"type": "image\_url",
"role": "reference\_image",
"image\_url": {
"url": "asset://<asset\_id>"
}
}
],
"duration": 5,
"ratio": "16:9"
}
asset://<素材 ID>。文本提示词按同类型素材在content中的顺序引用,例如“图片 1”“视频 1”或“音频 1”,不要直接写素材 ID。CreateVisualValidateSession的CallbackURL是业务方接收认证结果的 URL,可空。GetVisualValidateResult以BytedToken查询认证结果。认证完成时,响应Result.GroupId为素材组 ID;认证尚未完成、失败或过期时,Result.Error.Code分别为NotReady、Failed或Expired。| HTTP | error.type | error.code | 场景 |
|---|---|---|---|
400 | invalid\_request\_error | invalid\_request\_body | JSON 非法、缺少model,或缺少合法content |
400 | invalid\_request\_error | callback\_url\_invalid | callback\_urlURL 语法非法 、缺 scheme/host 或含 userinfo |
400 | invalid\_request\_error | callback\_url\_too\_long | callback\_url超过长度限制 |
400 | invalid\_request\_error | callback\_url\_scheme\_forbidden | callback\_urlscheme 不被允许 |
400 | invalid\_request\_error | callback\_url\_private\_ip | callback\_url裸 IP 命中私网 / 回环 / 链路本地地址 |
503 | service\_unavailable | model\_route\_unavailable | 提交前标准选路没有可执行openai\_videos/unary渠道,或 route binding 无法提供可用候选;响应可能包含既有reason\_codes |
500 | internal\_error | internal\_error | 提交前 selector 内部错误或已验证路由快照不合法 |
404 | not\_found | task\_not\_found | task 不存在或不属于当前调用方 |
409 | upstream\_error | upstream\_error | 当前任务状态不允许取消 / 删除 |
502 | proxy\_error | upstream\_body\_malformed | 生成服务响应格式异常,或任务状态无法识别 |
4xx/5xx | upstream\_error | upstream\_error | 生成服务返回错误;响应头X-平台-Error-Source: upstream |
| HTTP | error.code | 场景 |
|---|---|---|
400 | invalid\_assets\_action | 缺少或不支持的Action |
403 | capability\_disabled | 当前应用未开通素材库能力 |
403 | assets\_channel\_disabled | 素材库能力未启用 |
403 | assets\_visual\_validate\_disabled | 当前应用未开通真人认证能力 |
404 | asset\_group\_not\_found | 素材组不存在或不可访问 |
404 | asset\_not\_found | 素材不存在或不可访问 |
503 | assets\_route\_unavailable | 素材库服务暂不可用 |
4xx/5xx | upstream\_error | 素材库服务返回错误 |