本文介绍 openai/sora-2/text-to-video 模型异步任务相关的两个核心 API(异步提交任务、查询任务状态),详细说明各接口的请求地址、输入输出参数及调用示例,供接口使用时查阅。
1. 认证方式
所有接口均采用 API Key 认证,统一使用 Authorization 请求头,格式如下:
Authorization: \<YOUR\_API\_KEY\>
说明:将 \<YOUR\_API\_KEY\> 替换为您实际的 API Key 即可完成认证。
2. 异步提交任务接口
该接口用于提交视频生成异步任务,提交成功后返回任务唯一标识(task_id),后续可通过该标识查询任务状态及生成结果。
2.1 接口地址
https://api.modelverse.cn/v1/tasks/submit
2.2 输入参数
| 参数 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
| model | string | 是 | 模型名称,固定为 openai/sora\-2/text\-to\-video |
| input.prompt | string | 是 | 提示词,用于指导视频生成,明确视频内容、风格等要求 |
| parameters.size | string | 否 | 生成视频的尺寸,可选分辨率:- 720x1280- 1280x720默认值:720x1280 |
| parameters.duration | int | 否 | 视频生成时长(单位:秒),可选值:4、8、12,默认值:4 |
2.3 调用注意事项
如果您使用 Windows 系统,建议使用 Postman 或其他 API 调用工具,避免命令行调用出现兼容问题。
2.4 请求示例(curl)
curl --location --globoff 'https://api.modelverse.cn/v1/tasks/submit' \
--header 'Authorization: <YOUR_API_KEY>' \
--header 'Content-Type: application/json' \
--data '{
"model": "openai/sora-2/text-to-video",
"input": {
"prompt": "A beautiful girl is dancing"
},
"parameters": {
"size": "720x1280",
"duration": 4
}
}'
2.5 输出参数
| 参数 | 类型 | 描述 |
|---|---|---|
| output.task_id | string | 异步任务的唯一标识,用于后续查询任务状态 |
| request_id | string | 本次请求的唯一标识,用于问题排查时定位具体请求 |
2.6 响应示例
{
"output": {
"task_id": "task_id"
},
"request_id": "request_id"
}
3. 查询任务状态接口
该接口用于查询已提交异步任务的执行状态、生成结果(视频URL)及相关信息,需传入异步提交任务时返回的 task_id。
3.1 接口地址
https://api.modelverse.cn/v1/tasks/status?task_id=<task_id>
说明:将 \<task\_id\> 替换为异步提交任务时获取的实际 task_id。
3.2 输入参数
输入参数通过 URL 路径参数传递,具体如下:
| 参数 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
| task_id | string | 是 | 异步任务的唯一标识,由异步提交任务接口返回 |
3.3 请求示例(curl)
curl --location 'https://api.modelverse.cn/v1/tasks/status?task_id=<task_id>' \
--header 'Authorization: <YOUR_API_KEY>'
3.4 输出参数
| 参数 | 类型 | 描述 |
|---|---|---|
| output.task_id | string | 异步任务的唯一标识 |
| output.task_status | string | 任务状态,可选值:Pending(待处理)、Running(执行中)、Success(成功)、Failure(失败) |
| output.urls | array | 视频结果的 URL 列表,仅当 task_status 为 Success 时返回 |
| output.submit_time | integer | 任务提交时间戳(单位:秒) |
| output.finish_time | integer | 任务完成时间戳(单位:秒),仅当 task_status 为 Success 或 Failure 时返回 |
| output.error_message | string | 任务失败时返回的错误信息,仅当 task_status 为 Failure 时返回 |
| usage.duration | integer | 任务执行时长(单位:秒) |
| request_id | string | 本次请求的唯一标识,用于问题排查 |
3.5 响应示例
3.5.1 成功响应示例
{
"output": {
"task_id": "task_id",
"task_status": "Success",
"urls": ["https://xxxxx/xxxx.mp4"],
"submit_time": 1756959000,
"finish_time": 1756959050
},
"usage": {
"duration": 4
},
"request_id": ""
}
3.5.2 失败响应示例
{
"output": {
"task_id": "task_id",
"task_status": "Failure",
"submit_time": 1756959000,
"finish_time": 1756959019,
"error_message": "error_message"
},
"usage": {
"duration": 5
},
"request_id": ""
}