Yeehoo 对外 API 快速开始
从 API Key、图片视频任务、轮询到 webhook 回调,快速接入 Yeehoo 对外能力。
Yeehoo 当前对外 API 采用“异步任务”为核心模型,适合服务端接入图片和视频生成能力。
当前对外开放范围
当前公开给开发者的能力,聚焦在稳定、易接入的任务型接口:
- 图片生成任务
- 视频生成任务
- 通用任务查询
- 通用任务取消
- OpenAI 兼容模型列表
- OpenAI 兼容文本接口
- API 账户余额查询
- API Key 级 webhook 回调
当前不把前端内部的持久化会话能力作为正式对外承诺。
也就是说,现阶段开发者接入 Yeehoo,建议把它理解成:
- 一个对外的图片/视频异步生成 API
- 一个兼容 OpenAI 的文本与模型访问入口
- 一个带轮询和 webhook 的任务系统
而不是一个已经完整开放“会话存档 / 多轮上下文 / 会话管理”的外部平台接口。
典型调用链路
- 在控制台创建 API Key
- 调用图片或视频生成接口,提交一个异步任务
- 从创建响应里拿到
task_id - 通过
/v1/tasks/{task_id}轮询任务状态 - 如果需要服务端主动通知,再为 API Key 配置 webhook
最推荐的接入方式
建议第一版按下面顺序接:
- 先接图片或视频任务创建
- 先用轮询跑通结果获取
- 再补 webhook 做生产化通知
- 最后再补错误重试、幂等和告警
这样做的好处是:
- 最容易定位问题
- 不依赖回调基础设施
- 能先验证模型、计费、返回结构是否符合预期
什么暂时不建议对外依赖
以下能力如果只是前端内部已经存在,不代表现在就适合作为外部开发接口承诺:
- 持久化对话会话
- 前端侧 Playground 运行记录
- 内部运营或后台接口
如果后续要开放持久化会话能力,建议等这几件事稳定后再做:
- 会话对象模型稳定
- 权限边界清晰
- 分页、删除、上下文管理规则清晰
- 文本模型能力和配额模型成熟