Yeehoo 开发者

创建任务

统一提交图片或视频生成任务;服务端会根据 model 自动识别任务类型并返回 task_id。

这是对外生成能力最核心的创建接口。

你不需要分别记图片接口和视频接口。当前推荐直接调用:

POST /v1/generations

服务端会根据你传入的 model 自动判断这是图片任务还是视频任务。

接口概览

说明
路由POST /v1/generations
鉴权Authorization: Bearer sk_yeehoo_xxx
幂等建议传 Idempotency-Key,避免重复下单
请求体application/json
返回201 Created + 任务对象
结果获取轮询 GET /v1/tasks/{task_id} 或等待 webhook

接入提醒

不要把这个接口当成同步返回图片或视频结果的接口。创建成功只代表任务已入队,最终内容要看任务终态。

Authorizations

所有对外生成接口都使用 API Key Bearer 鉴权。

Authorization: Bearer sk_yeehoo_your_api_key
Content-Type: application/json
Idempotency-Key: gen-demo-001

Header 说明

Header必填说明
Authorization固定格式 Bearer sk_yeehoo_xxx
Content-Type固定为 application/json
Idempotency-Key强烈建议同一次业务提交保持同一个值,防止网络重试导致重复创建任务

Body

先看最常用、最该传的字段。

通用必填字段

字段类型必填示例说明
modelstringgpt-image-2指定具体模型。服务端根据模型判断是图片任务还是视频任务
promptstringA cinematic fashion poster...生成指令,建议直接写清主体、风格、构图、光线、镜头感

图片任务常用字段

适用于当前公开图片模型:gpt-image-2nano-banana-2nano-banana-pro

字段类型必填默认值示例说明
reference_imagesstring[]-["https://.../ref1.png"]参考图 URL 列表,适合做风格参考或局部重绘
aspect_ratiostringauto1:1输出宽高比
resolutionstring模型相关1K输出分辨率
ninteger12本次任务希望生成的图片数量

视频任务常用字段

适用于当前公开视频模型,例如 sora-2seedance-2

字段类型必填默认值示例说明
first_frame_image_urlstring-https://.../cover.png首帧图或起始参考图
reference_modestring模型默认first_frame参考图使用方式,具体以模型支持为准
aspect_ratiostring模型默认16:9视频宽高比
resolutionstring模型默认720p视频清晰度,具体枚举取决于模型
durationinteger模型默认5视频时长,单位通常为秒

Response

创建成功后,服务端通常会先返回一个任务对象。

创建成功响应示例

{
  "task_id": "task_01jxyz...",
  "object": "task",
  "kind": "image",
  "model": "gpt-image-2",
  "status": "queued",
  "progress": 0,
  "created_at": 1784779200,
  "completed_at": 0
}

响应字段说明

字段类型说明
task_idstring后续轮询和 webhook 对账的核心 ID
objectstring对象类型,通常为 task
kindstring任务类型,通常为 imagevideo
modelstring本次实际执行的模型
statusstring当前状态,如 queuedrunningsucceededfailed
progressinteger任务进度百分比,终态通常为 100 或保留终态值
created_atinteger创建时间戳
completed_atinteger完成时间戳;未完成时可能为空值或 0
resultobject终态成功时返回的结果内容
errorobject终态失败时返回的错误对象

成功后的下一步

  1. 记录 task_id
  2. 调用 GET /v1/tasks/{task_id} 轮询任务状态
  3. 或者提前给 API Key 配置 webhook,等待 task.completed / task.failed

轮询和回调怎么选

场景建议
本地联调先只接轮询,排查最直观
正式生产轮询保底,webhook 做异步通知
要求强一致收到 webhook 后仍建议按 task_id 再查一次任务详情