跳转到主要内容
异步调用说明: 适合批量处理场景,提交任务后通过轮询获取结果。如需实时交互,请使用同步调用方式

1. 创建视频任务

/v1/videos
创建异步视频生成任务

请求头

Content-Type: application/json
Authorization: sk-APIKEY

请求参数

prompt
string
required
视频生成的文本描述
model
string
required
模型名称。可选值:
  • veo-3.1 - 竖屏标准版
  • veo-3.1-fl - 竖屏+帧转视频
  • veo-3.1-fast - 竖屏快速版
  • veo-3.1-fast-fl - 竖屏快速+帧转视频
  • veo-3.1-landscape - 横屏标准版
  • veo-3.1-landscape-fl - 横屏+帧转视频
  • veo-3.1-landscape-fast - 横屏快速版
  • veo-3.1-landscape-fast-fl - 横屏快速+帧转视频

请求示例

curl --location --request POST 'https://api.apiyi.com/v1/videos' \
--header 'Authorization: sk-your-api-key' \
--header 'Content-Type: application/json' \
--data-raw '{
    "prompt": "画小猫",
    "model": "veo-3.1"
}'

响应示例

{
  "id": "video_abc123",
  "object": "video",
  "created": 1762181811,
  "status": "queued",
  "model": "veo-3.1"
}
响应中的 id 字段即为视频任务 ID,后续用于查询任务状态和获取视频内容。

2. 查询视频任务状态

/v1/videos/{video_id}
查询视频生成任务的当前状态

路径参数

video_id
string
required
视频任务 ID(从创建接口返回)

请求头

Authorization: sk-APIKEY

请求示例

curl --location --request GET 'https://api.apiyi.com/v1/videos/video_abc123' \
--header 'Authorization: sk-your-api-key'

响应示例

{
  "id": "video_abc123",
  "object": "video",
  "created": 1762181811,
  "status": "completed",
  "model": "veo-3.1",
  "prompt": "画小猫"
}

状态说明

状态说明下一步操作
queued任务排队中继续轮询状态
processing任务处理中继续轮询状态
completed生成完成调用获取内容接口
failed生成失败检查错误信息
轮询建议: 建议每 5-10 秒轮询一次任务状态,直到状态变为 completedfailed

3. 获取视频内容

/v1/videos/{video_id}/content
获取已生成视频的实际内容

路径参数

video_id
string
required
视频任务 ID

请求头

Authorization: sk-APIKEY

请求示例

curl --location --request GET 'https://api.apiyi.com/v1/videos/video_abc123/content' \
--header 'Authorization: sk-your-api-key'

响应示例

{
  "id": "video_abc123",
  "object": "video",
  "created": 1762181811,
  "status": "completed",
  "model": "veo-3.1",
  "prompt": "画小猫",
  "url": "https://veo-video.gptkey.asia/assets/flow/xxx.mp4",
  "duration": 8,
  "resolution": "720x1280"
}
视频 URL 有效期通常为 24 小时,建议及时下载保存。

完整调用流程

1

创建任务

调用 POST /v1/videos 接口创建视频生成任务,获取 video_id
2

轮询状态

使用 GET /v1/videos/ 接口轮询任务状态,直到状态为 completed
3

获取视频

调用 GET /v1/videos//content 接口获取视频 URL
4

下载视频

从返回的 URL 下载视频文件并保存

错误处理

常见错误码

错误码说明解决方案
invalid_api_keyAPI 密钥无效检查 API 密钥是否正确
invalid_model模型不存在使用支持的模型名称
invalid_prompt提示词无效检查提示词长度和内容
video_not_found视频任务不存在检查 video_id 是否正确
video_not_ready视频尚未生成完成继续轮询任务状态
quota_exceeded配额超限联系客服增加配额

错误响应格式

{
  "error": {
    "code": "invalid_api_key",
    "message": "Invalid API key provided",
    "type": "authentication_error"
  }
}