16参考手册
OpenAPI
一个文件说明公开 API 的所有方法。把它加载到 Postman 或客户端生成器中，方法、字段和响应码就会自动出现。
文件
openapi.jsonOpenAPI 3.1 · 5 个方法
这是标准的 OpenAPI 3.1 文件。它涵盖五个方法、请求体和响应体的格式，以及鉴权方案。
文件里有什么
POST/images/generate创建图片
GET/creations/{id}状态与结果
POST/uploads上传参考图
GET/models目录与价格
返回你的账号可用的模型，以及按分辨率划分的价格。
200401429
GET/balance余额
以字符串形式返回余额、信用额度和可用金额。
200401429
这里展示的是主要的响应码，完整列表见“错误码”一节。Webhook 不在文件中：接收地址由你在生成请求里指定，事件的格式见“Webhook”一节。
如何使用
在 Postman 或 Insomnia 中打开文件
在应用中选择“Import”，粘贴文件的链接，或把下载的
openapi.json拖进去。方法会成组出现：只需在鉴权中添加密钥。为你的语言
生成客户端 任何支持 OpenAPI 3.1 的生成器都可以。例如，生成 TypeScript 类型：
npx openapi-typescript openapi.json -o rendergrid.d.tsPython 客户端（需要 Java）：
npx @openapitools/openapi-generator-cli generate \ -i openapi.json -g python -o ./rendergrid-client用一次真实请求
检查响应 文件列出了字段和响应码，但不能代替实际检查。请发送一次“快速开始”中的请求，并把响应与文件中的说明对照。
鉴权
文件中定义了两种方案，两者接受同一个密钥：
| 方案 | 请求头 | 示例 |
|---|---|---|
| Bearer | Authorization | Authorization: Bearer rg_live_… |
| 请求头中的密钥 | X-API-Key | X-API-Key: rg_live_… |
在哪里获取密钥以及如何妥善保管，见“密钥与鉴权”一节。
版本与变更
API 的版本是地址的一部分：/api/。在同一版本内，响应中可能出现新的字段和新的错误码，因此解析响应时请保持宽容：忽略不认识的字段，不认识的错误码按其类型处理。
变更的内容和时间见“更新日志”页面。
常见问题
这个文件和文档有什么区别？
文档讲解如何使用 API，而 OpenAPI 文件是对它的形式化说明：方法、字段、类型和响应码。它是给程序读的，而不是给人读的。
可以只导入一个方法吗？
请导入整个文件：在 Postman 或 Insomnia 中，导入之后可以删掉多余的方法。
有更新时如何刷新文件？
重新下载并与旧文件对比。新功能我们会在“更新日志”中说明。