Skip to main content
本指南只描述当前开发者预览合同：GPT Image 2 文生图的 KIE 兼容与 APIMart 兼容入口。

保护密钥

Yir API Key 只保存在服务端，并且只作为 Bearer Credential 发送。

跟踪逻辑请求

在开始轮询前持久化幂等键和任务 ID。

处理未知结果

重试查询，不要把超时变成第二次生成请求。

​
提交合同

1

生成幂等键

为一个逻辑生成请求生成一个不透明值。
2

提交请求

选择已有集成熟悉的 KIE 或 APIMart 兼容格式。
3

保存任务 ID

先将任务 ID 写入本地业务记录，再启动后台轮询。
4

查询到终态

使用有界轮询；临时网络错误后继续查询同一个任务。
提交响应超时后不要直接生成新的幂等键。原请求可能已经被接受，并可能产生费用事实。
​
string
必填
使用 Bearer $YIR_API_KEY 格式的 Yir Credential。
​
string
必填
调用方为逻辑请求生成的不透明标识。相同键配合不同请求数据会被拒绝。

​
两种兼容入口

使用 createTask 提交，读取 data.taskId，然后通过 recordInfo 查询。

​
轮询与恢复

从保守间隔开始，加入抖动，并在应用侧设置总期限。轮询超时不是任务失败事实。
不要。继续查询现有任务 ID。除非是相同数据和相同幂等键的重试，否则会成为第二个逻辑请求。
可以提供任务 ID、来源路径、大致 UTC 时间、HTTP 状态、公开错误码和安全的 Key 前缀；不要提供完整 Key、Prompt、原始素材或 Provider 响应。
当你的实现能够保存两个标识、正确重试提交、持续查询同一任务，并且不会向浏览器暴露 API Key 时，就可以进行受控测试。