跳转到主要内容

PoYo AI API 文档

PoYo AI 通过一个 API Key 提供图像、视频、LLM、3D 和音乐 API。

模型类别

生成模型(图像、视频、3D、音乐)以异步任务方式运行。LLM 直接在 HTTP 响应中返回结果,或以流式方式返回。 本页其余部分介绍生成模型使用的异步任务流程。

Base URL

所有 API 请求都应发送到:

认证

PoYo AI 使用 API Key 认证。在 Authorization 请求头中携带你的 API Key:

获取 API Key

访问 API 控制台生成你的 API Key

API 架构

统一接口

图像、视频、3D 和大多数音频模型使用两个接口:

提交任务

提交生成请求。立即返回 task_id。

查询状态

查看任务进度并获取结果。

异步处理

所有生成任务都遵循以下流程:
1

提交任务

向 /api/generate/submit 发送 POST 请求,携带模型和参数
2

获取任务 ID

API 立即返回 task_id,状态为 not_started
3

轮询或等待

轮询 /api/generate/status/{task_id},或接收 Webhook 回调
4

获取结果

状态为 finished 时,从响应中获取生成的文件

响应格式

所有接口都返回结构一致的 JSON:

提交响应

状态响应

任务状态值

错误响应

HTTP 状态码

任务管理方式

方式 1:轮询(简单)

定期轮询状态接口:

方式 2:Webhook(推荐)

提供 callback_url 以自动接收通知:

Webhook 文档

了解如何实现 Webhook 回调

重要说明

文件有效期:生成的图像和视频在创建后 3 天内可访问。请及时下载并保存。
速率限制:API 速率限制因账户类型而异。在控制台查看当前限制。
回调与轮询:Webhook 比轮询更高效,推荐在生产环境中使用。

快速示例