Skip to main content
本文将介绍 Sora Videos Generation API 的对接说明,通过该 API 可以输入自定义参数来生成 Sora 官方的视频。本 API 支持两种版本模式:
  • Version 1(经典模式):支持 duration(10/15/25 秒)、orientation(横屏/竖屏)、size(small/large 清晰度)、参考图 image_urls、角色视频 character_url 等参数。
  • Version 2(合作商模式):支持 seconds(4/8/12 秒)、像素级分辨率 size(如 1280x720)、参考图 input_reference 等参数。

申请流程

要使用 Sora Videos Generation API,首先到 Ace Data Cloud 控制台 获取您的 API Token,留作备用。 如果你尚未登录或注册,会自动跳转到登录页面邀请你注册和登录,完成后会自动返回当前页面。 一个 API Token 即可调用平台所有服务,无需为每个服务单独申请。 首次申请会赠送免费额度,可免费体验;额度不足时可在 控制台 充值通用余额。
📘 完整文档:Sora Videos Generation API →

基本使用(Version 1)

首先先了解 Version 1 的基本使用方式,就是输入提示词 prompt、参考图片链接数组 image_urls 以及模型 model,便可获得处理后的结果,具体的内容如下:

可以看到这里我们设置了 Request Headers,包括:
  • accept:想要接收怎样格式的响应结果,这里填写为 application/json,即 JSON 格式。
  • authorization:调用 API 的密钥,申请之后可以直接下拉选择。
另外设置了 Request Body,包括:
  • model:生成视频的模型,支持 sora-2(标准模式)和 sora-2-pro(高清模式)。其中 sora-2-pro 可以支持 duration 为 25 秒的视频,而 sora-2 只支持 10、15 秒。
  • size:视频清晰度,small 为标准清晰度、large 为 HD 清晰度(仅 Version 1)。
  • duration:视频时长,支持 10、15、25 秒,其中 25 秒仅 sora-2-pro 支持(仅 Version 1)。
  • orientation:画幅方向,支持 landscape(横屏)、portrait(竖屏)(仅 Version 1)。
  • image_urls:参考图片链接数组,用于图生视频(仅 Version 1)。
  • character_url:角色视频链接,视频中不能出现真人(仅 Version 1)。
  • character_start/character_end:角色出现的起止秒数,范围差值为 1-3 秒(仅 Version 1)。
  • prompt:提示词(必填)。
  • callback_url:异步回调结果的 URL。
  • async:可选,设为 true 时接口立即返回 task_id,无需提供 callback_url,随后通过对应的任务查询接口轮询获取结果。
  • version:API 版本,"1.0"(默认)或 "2.0"
选择之后,可以发现右侧也生成了对应代码,如图所示:

点击「Try」按钮即可进行测试,如上图所示,这里我们就得到了如下结果:
返回结果一共有多个字段,介绍如下:
  • success,此时视频生成任务的状态情况。
  • task_id,此时视频生成任务ID。
  • trace_id,此时视频生成跟踪ID。
  • data,此时视频生成任务的结果列表。
    • id,此时视频生成任务的视频ID。
    • video_url,此时视频生成任务的视频链接。
    • state,此时视频生成任务的状态。
可以看到我们得到了满意的视频信息,我们只需要根据结果中 data 的视频链接地址获取生成的Sora视频即可。 另外如果想生成对应的对接代码,可以直接复制生成,例如 CURL 的代码如下:

图生视频任务(Version 1)

如果想进行图生视频任务,首先参数 image_urls 必须传入参考图片链接,就可以指定如下内容:
  • image_urls:该图生视频任务采用的参考图链接数组。注意不可传递真实的带有头像的人物图像,否则可能导致任务失败。
填写样例如下:

填写完毕之后自动生成了代码如下:

对应的代码:
点击运行,可以发现会立即得到一个结果,如下:
可以看到,生成的效果是图生建视频的,结果与上文类似。

角色生成视频任务(Version 1)

如果想进行角色生成视频任务,首先参数 character_url 必须传入创建角色需要的视频链接,注意视频中一定不能出现真人,否则会失败,就可以指定如下内容:
  • character_url:创建角色需要的视频链接,注意视频中一定不能出现真人,否则会失败。
填写样例如下:

填写完毕之后自动生成了代码如下:

对应的代码:
点击运行,可以发现会立即得到一个结果,如下:
可以看到,生成的效果是角色生成视频,结果与上文类似。

Version 2.0 模式

除了上述 Version 1.0 模式之外,本 API 还支持 Version 2.0 模式,通过设置 version 参数为 "2.0" 即可启用。Version 2.0 模式支持更短的视频时长和像素级的分辨率控制。

Version 2.0 参数说明

基本示例

对应的 Python 代码:
对应的 JavaScript 代码:
返回结果格式与 Version 1 相同:

使用参考图片(Version 2.0)

在 Version 2.0 模式下,可以通过 image_urls 参数传入参考图片来引导视频生成(仅使用第一张图片):
注意:参考图片的尺寸应与 size 参数保持一致,例如 size1280x720 时,参考图片尺寸应为 1280×720。

Version 1.0 与 Version 2.0 参数对比

异步回调

由于 Sora Videos Generation API生成的时间相对较长,大约需要 1-2 分钟,如果 API 长时间无响应,HTTP 请求会一直保持连接,导致额外的系统资源消耗,所以本 API 也提供了异步回调的支持。 整体流程是:客户端发起请求的时候,额外指定一个 callback_url 字段,客户端发起 API 请求之后,API 会立马返回一个结果,包含一个 task_id 的字段信息,代表当前的任务 ID。当任务完成之后,生成视频的结果会通过 POST JSON 的形式发送到客户端指定的 callback_url,其中也包括了 task_id 字段,这样任务结果就可以通过 ID 关联起来了。 下面我们通过示例来了解下具体怎样操作。 首先,Webhook 回调是一个可以接收 HTTP 请求的服务,开发者应该替换为自己搭建的 HTTP 服务器的 URL。此处为了方便演示,使用一个公开的 Webhook 样例网站 https://webhook.site/,打开该网站即可得到一个 Webhook URL,如图所示: 将此 URL 复制下来,就可以作为 Webhook 来使用,此处的样例为 https://webhook.site/eb238c4f-da3b-47a5-a922-a93aa5405daa 接下来,我们可以设置字段 callback_url 为上述 Webhook URL,同时填入相应的参数,具体的内容如图所示:

点击运行,可以发现会立即得到一个结果,如下:
稍等片刻,我们可以在 https://webhook.site/eb238c4f-da3b-47a5-a922-a93aa5405daa 上观察到生成视频的结果,如图所示: 内容如下:
可以看到结果中有一个 task_id 字段,其他的字段都和上文类似,通过该字段即可实现任务的关联。

错误处理

在调用 API 时,如果遇到错误,API 会返回相应的错误代码和信息。例如:
  • 400 token_mismatched:Bad request, possibly due to missing or invalid parameters.
  • 400 api_not_implemented:Bad request, possibly due to missing or invalid parameters.
  • 401 invalid_token:Unauthorized, invalid or missing authorization token.
  • 429 too_many_requests:Too many requests, you have exceeded the rate limit.
  • 500 api_error:Internal server error, something went wrong on the server.

错误响应示例

结论

通过本文档,您已经了解了如何使用 Sora Videos Generation API 可通过输入提示词以及参考图片来生成视频。希望本文档能帮助您更好地对接和使用该 API。如有任何问题,请随时联系我们的技术支持团队。