Skip to content

视频超分 API

视频超分采用异步任务模式:先创建任务,再轮询任务状态,直到任务完成或失败。

创建视频超分任务

POST https://art-api.yuyuflow.com/v1/videos

鉴权

本接口使用 API Key 鉴权,请在 https://art-api.yuyuflow.com/dashboard/overview 获取 API Key,并通过 Authorization: Bearer <API_KEY> 传入。

参数必填说明
AuthorizationBearer <YOUR_API_KEY>
Content-Typeapplication/json

JSON Body 参数

参数必填示例说明
modelai-video-upscale-v1视频超分模型
promptupscale协议必填占位参数,不用于控制视频超分效果,建议固定传 upscale
video_urlhttps://your-oss-domain/path/input.mp4可公开访问的视频地址
size720p输出清晰度,支持 720p1080p4k,默认 720p

如果只有本地视频文件,需要先上传到 OSS 或 CDN,再将可访问的视频 URL 传给 video_url

注意

  • 请勿输入超过 30 秒的视频。
  • 请勿输入超过 24 fps 的视频。
  • 超分限制:
    • 超分至720p的只允许输入是480p的视频
    • 超分至1080p的只允许输入是720p的视频
    • 超分至4k的只允许输入是1080p的视频

请求示例

bash
curl --location 'https://art-api.yuyuflow.com/v1/videos' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "model": "ai-video-upscale-v1",
    "prompt": "upscale",
    "size": "1080p",
    "video_url": "https://your-oss-domain/path/input.mp4"
  }'

创建成功响应

json
{
  "id": "task-video-123",
  "task_id": "task-video-123",
  "object": "video",
  "model": "ai-video-upscale-v1",
  "status": "queued",
  "progress": 0,
  "created_at": 1710000000000
}

请保存 id,后续使用任务 ID 查询状态和获取视频内容。

查询视频超分任务

GET https://art-api.yuyuflow.com/v1/videos/{id}

请求示例

bash
curl --location 'https://art-api.yuyuflow.com/v1/videos/task-video-123' \
  --header 'Authorization: Bearer YOUR_API_KEY'

处理中响应

json
{
  "id": "task-video-123",
  "task_id": "task-video-123",
  "object": "video",
  "model": "",
  "status": "in_progress",
  "progress": 30,
  "created_at": 1710000000000,
  "metadata": {
    "queue": 0
  }
}

完成响应

json
{
  "id": "task-video-123",
  "model": "",
  "object": "video",
  "status": "completed",
  "seconds": "8",
  "task_id": "870671702034628671",
  "metadata": {
    "url": "https://hostname/path/result.mp4",
    "queue": 0
  },
  "progress": 100,
  "created_at": 1785392808654,
  "completed_at": 1785392808654
}

任务完成后,从 metadata.url 获取超分后的视频地址并及时下载或转存。

结果保存时间

仅支持查询最近 7 天的任务记录,时间区间为 [T-7天, T),其中 T 为请求发起时刻的 UTC 时间戳(精确到秒)。视频 URL 有效期为 24 小时,请及时下载或转存。

失败响应

json
{
  "id": "task-video-123",
  "task_id": "task-video-123",
  "object": "video",
  "model": "",
  "status": "failed",
  "progress": 100,
  "created_at": 1710000000000,
  "error": {
    "code": "render_task_failed",
    "message": "render task failed"
  },
  "metadata": {
    "queue": 0
  }
}

状态说明

status说明客户端处理
queued任务已创建,等待处理继续轮询
in_progress任务处理中继续轮询
completed任务完成读取 metadata.url,及时下载或转存视频
failed任务失败读取 error.codeerror.message

常见错误

错误信息原因处理方式
prompt is required协议要求 prompt 必填固定传 prompt="upscale",该字段不影响超分效果
videoUrl is required for video upscale task没有传入 video_url检查 JSON Body 中的视频地址是否为空
invalid API key鉴权失败检查 Authorization 请求头和 API Key