跳转至

接口总览

💫 中继接口

🖥️ 前端接口

  • 即将推出

    前端接口文档正在码字中，敬请期待！

    了解更多 →

📖 接口说明

接口类型

提供两大类接口：

  1. 中继接口：用于 AI 模型的调用，支持多种主流模型格式
  2. 前端接口：用于支持 Web 界面的功能调用，提供完整的前端功能支持

功能支持标识

在接口文档中，我们使用以下图标来标识功能支持状态：

  • ✅ 已支持：该功能已经完全实现并可以使用
  • 🟡 部分支持：功能已可用，但存在限制或仅提供部分能力
  • ❌ 未支持：该功能正在开发中或计划开发

快速开始

  1. 浏览上方卡片选择需要使用的接口
  2. 点击对应卡片的"查看详情"了解具体用法
  3. 按照文档说明进行接口调用

🎬 视频接口教程

接口概述

本文档提供 AI 视频生成相关的 API 接口说明，包含创建视频生成任务和查询任务状态两个接口。提交任务后返回任务 ID，可通过查询接口获取任务进度并下载生成的视频结果。当前支持的模型为 Doubao-Seedance-2.0、Doubao-Seedance-2.0-fast、Doubao-Seedance-2.0-mini。

接口列表

模型名 接口类型 接口地址
Doubao-Seedance-2.0, Doubao-Seedance-2.0-fast, Doubao-Seedance-2.0-mini 创建任务 POST https://napi.funengyun.com/v1/video/generations
同上 获取状态 GET https://napi.funengyun.com/v1/video/generations/{task_id}

创建视频生成任务

提交视频生成任务，支持文生视频和图生视频。返回任务 ID 后，可通过 GET 接口查询任务状态。

请求信息

请求方法 请求 URL Content-Type 认证方式
POST https://napi.funengyun.com/v1/video/generations application/json Bearer Token

请求头：Authorization: Bearer <token>，编码格式：UTF-8。

Request Body 参数

参数名 类型 必填 说明
model string 是 模型 / 风格 ID
prompt string 是 文本描述提示词
image string 否 图片输入（URL 或 Base64）
duration number 是 视频时长（秒）
width integer 是 视频宽度（像素）
height integer 是 视频高度（像素）
fps integer 否 视频帧率
seed integer 否 随机种子
n integer 否 生成视频数量
response_format string 否 响应格式
user string 否 用户标识
metadata object 否 扩展参数（如 negative_prompt、style、quality_level 等）

响应信息

200 成功响应：成功创建视频生成任务时返回 HTTP 状态码 200。

字段名 类型 说明
task_id string 视频生成任务的唯一标识 ID
status string 任务状态，创建成功为 queued

响应示例（200 OK）：

{
  "task_id": "task_xxxxxxxxxxxx",
  "status": "queued"
}

400 响应：请求参数错误时返回 HTTP 状态码 400。

调用示例（cURL）

curl -X POST "https://napi.funengyun.com/v1/video/generations" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "Doubao-Seedance-2.0",
    "prompt": "一只兔子在拔萝卜。",
    "duration": 8,
    "metadata": {
      "ratio": "16:9",
      "generate_audio": true,
      "resolution": "720p"
    }
  }'

获取视频生成任务状态

查询视频生成任务的状态和结果。通过任务 ID 获取视频生成的进度、结果 URL 以及元数据信息。

请求信息

请求方法 请求 URL Content-Type 认证方式
GET https://napi.funengyun.com/v1/video/generations/{task_id} application/json Bearer Token

请求头：Authorization: Bearer <token>，编码格式：UTF-8。

Path 参数

参数名 类型 必填 说明
task_id string 是 视频生成任务的唯一标识 ID

任务状态说明

状态值 说明
queued 排队中，任务已提交等待处理
in_progress 生成中，视频正在生成
Completed / Succeeded 已完成，视频生成成功
failed 失败，视频生成失败

响应信息

200 成功响应：请求成功时返回 HTTP 状态码 200，响应体为 application/json 格式。

字段名 类型 说明
task_id string 任务唯一标识 ID
status string 任务状态（queued / in_progress / completed / failed）
url string 生成完成后视频文件的下载 URL
format string 视频文件格式，如 mp4
metadata object 视频元数据信息
metadata.duration integer 视频时长（秒）
metadata.fps integer 帧率
metadata.width integer 视频宽度（像素）
metadata.height integer 视频高度（像素）
metadata.seed integer 随机种子

响应示例（200 OK）：

{
  "code": "success",
  "message": "",
  "data": {
    "task_id": "task_bsEgA4IDTyTLVLMMlxyFB8GSPZ0O4XL7",
    "id": "cgt-20260713152002-dhr6j",
    "model": "doubao-seedance-2-0",
    "priority": 0,
    "service_tier": "default",
    "status": "running",
    "updated_at": 1783927202
  }
}

404 响应：当指定的 task_id 不存在时返回 HTTP 状态码 404。

调用示例（cURL）

curl -X GET "https://napi.funengyun.com/v1/video/generations/{task_id}" \
  -H "Authorization: Bearer <token>"

错误码说明

HTTP 状态码 错误码 (code) 说明
200 0 请求成功，无错误
400 - 请求参数错误（创建任务时）
404 - 任务不存在（查询状态时）

注意事项

  • 所有 API 请求均需在 Header 中携带有效的 Bearer Token 进行认证。
  • 创建任务时，task_id 由服务端返回，请妥善保存以便后续查询任务状态。
  • 视频生成完成后，url 字段提供的下载链接有一定的有效期（24 小时），请及时下载。
  • 当 status 为 failed 时，请检查 error 字段中的 code 和 message 以获取失败原因。
  • 文生视频时传 prompt 参数，图生视频时传 image 参数（URL 或 Base64 编码）。
  • 最大并发数限制：非 4K 分辨率 10 个，4K 分辨率 1 个。