02快速上手
通过 AI 接入新
把我们的文档交给 AI 助手，它就能为你编写集成代码。每个页面都有纯文本版本，整套文档则合并在一个文件中。
如何把文档交给 AI 助手
选择更方便的方式。它们适用于任何 AI 助手：ChatGPT、Claude、Cursor 等。
- 复制给 AI
- 标题上方的按钮会把每个页面的文本以 Markdown 格式放入剪贴板。把文本粘贴到对话中，助手就能看到与你相同的页面。
- 在 ChatGPT 或 Claude 中打开
- 旁边的两个按钮会打开对话，并直接传入页面的
.md。 - .md 页面
- 在任意文档页面的地址后加上
.md，即可得到不含排版的纯文本，例如rendergrid.io/。zh/ docs/ quickstart.md - llms.txt
- 所有页面的列表，每个页面附一行说明。AI 助手据此自行选择要读哪些页面。
- llms-full.txt
- 整套文档合并为一个文件，适合需要一次了解全部内容的 AI 助手。
先从“快速开始”页面开始：它足以让你得到第一张图片。其余内容，AI 助手会顺着其中的链接去读。
给 AI 助手的现成提示词
复制下面的文本，填入你自己的任务，然后发给 AI 助手。其中已经包含了最容易被忘记的规则。
请通过 Rendergrid API 在我的项目中接入图片生成。 文档：https://rendergrid.io/ llms.txt 完整文本：https:// rendergrid.io/llms-full.txt 规则： - 从环境变量 RENDERGRID_API_KEY 中读取密钥，不要把它写进代码； - 每个生成请求都添加 X-Idempotency-Key，并保存下来以便重试； - 查询任务状态的频率不要高于每 5 秒一次，或者改为接收 Webhook； - 立即保存 result_urls 中的图片：链接有效期为一天； - 收到 429 和 503 响应时，按 Retry-After 指定的秒数等待。
文档提供哪些文件
| 地址 | 内容 | 适用场景 |
|---|---|---|
/llms.txt | 页面列表及简短说明 | 初次了解、查找所需页面 |
/llms-full.txt | 文档全文 | AI 助手需要了解全部内容，且无需跳转链接 |
/zh/ | 单个页面的 Markdown | 针对性的问题：Webhook、错误、限额 |
/openapi.json | 全部 API 端点的说明 | 生成客户端——OpenAPI 页面 |
/skills/ | 适用于 Claude Code 的技能，英文 | 你在使用 Claude Code——“技能”板块 |
/skills/ | 适用于 Cursor 的规则，英文 | 你在使用 Cursor——“技能”板块 |
这些文件与文档同步更新。每个页面都标有最后更新的日期，更新记录见“更新日志”板块。
你的项目的 AGENTS.md 文件
将此文件放在代码仓库的根目录。许多编程 AI 助手会自行读取它并遵循其中的规则，无需提醒。
## Rendergrid API - Base URL：https://api.rendergrid.io/ api/ public/ v1 - 鉴权：请求头 `Authorization: Bearer $RENDERGRID_API_KEY`。 密钥只放在环境变量中，绝不写入代码和日志。 - 创建图片：`POST /images/ generate` -> 202 {id, status, task_id, cost}。 - 获取结果：`GET /creations/ {id}`，频率不高于每 5 秒一次。 状态：queued、processing、completed、failed。 - 重试：每个操作使用一个 `X-Idempotency-Key`；重试时使用同一个键。 新图片使用新的键。 - 错误：查看 `error.code`。遇到 429 和 503 时，按 `Retry-After` 等待。 - 结果文件保存一天——请立即下载。 - 文档：https:// rendergrid.io/ llms.txt
MCP 服务器
MCP 会把 Rendergrid 作为一组工具接入 AI 助手：助手可以自行生成图片、等待结果并查询余额。适用于 Claude Desktop、Cursor 等支持 MCP 的程序。有两种接入方式，它们的工具和价格完全相同。
远程服务器：程序通过地址 https://（也可使用 https://）连接我们，并在请求头 Authorization: Bearer 或 X-API-Key 中传入你的 API 密钥。无需安装任何东西。不带密钥的请求会收到 401。
{
"mcpServers": {
"rendergrid": {
"url": "https://本地桥接：如果程序不能通过地址连接，请用 npx 运行 @rendergrid/mcp 包，需要 Node.js 22+。桥接程序从环境变量中读取密钥。
{
"mcpServers": {
"rendergrid": {
"command": "npx",
"args": ["-y", "@rendergrid/mcp"],
"env": { "RENDERGRID_API_KEY": "rg_live_…" }
}
}
}请将 rg_live_… 替换为你的密钥：此文件不会展开环境变量。
| 工具 | 作用 | API 端点 |
|---|---|---|
generate_image | 生成图片，并等待结果，最长 45 秒 | POST /images/ |
get_creation | 返回状态和文件链接；如果任务仍在进行，最多等待 45 秒 | GET /creations/ |
upload_image | 上传用于编辑的参考图：PNG、JPEG 或 WebP，最大 25 MiB | POST /uploads |
list_models | 显示你的账号的模型和价格 | GET /models |
get_balance | 显示可用金额 | GET /balance |
generate_image 最多等待结果 45 秒。如果这段时间内图片尚未就绪，工具会返回任务 id，并提示改用 get_creation。
请用这个 id 请求 get_creation，频率不要高于每 5 秒一次：它同样最多等待 45 秒。不要重新运行 generate_image——那是一个新请求，也是一次新的扣费。
AI 助手会消耗你的余额：每张图片按其价格扣费，与普通请求相同。
请专门为 AI 助手创建一个单独的密钥：它可以随时撤销，而不会影响其他集成。为该密钥设置月度消费限额——这是该密钥的硬性限制（了解更多）。不要把存放密钥的配置文件提交到代码仓库。
适用于 Claude Code 和 Cursor 的技能
技能是为写代码的 AI 助手准备的现成说明：如何使用 Rendergrid API、需要哪些字段、如何获取结果，以及出错时怎么办。下载文件并放进项目，AI 助手会自行加载其中的规则。这些文件是用英文写的，因为读取它们的是模型，而不是人。
- Claude Code
- 文件
/skills/。请将其放到你项目的claude-code/ SKILL.md .claude/skills/rendergrid/SKILL.md。 - Cursor
- 文件
/skills/。请将其放到你项目的cursor/ rendergrid.mdc .cursor/rules/rendergrid.mdc。
技能由本文档整理而成，并随文档一同更新。不要把密钥写进文件：让 AI 助手从环境变量 RENDERGRID_API_KEY 中读取。
哪些内容不要交给 AI 助手
- API 密钥和 Webhook 签名密钥：让 AI 助手从环境变量中读取它们，不要把值本身粘贴到对话中。
- 客户数据：示例请使用虚构的数据，例如
you@example.com、5b0214ae-9e39-460a-820a-f6ae3e24400b。 - 对代码的盲目信任：请对照本文档核对 AI 助手写的代码，尤其是幂等键、轮询间隔和 Webhook 签名验证。
常见问题
可以直接把文档链接发给 AI 助手吗？
rendergrid.io/。如果不能，请点击“复制给 AI”，再把页面文本粘贴到对话中。把密钥交给 AI 助手安全吗？
RENDERGRID_API_KEY 中读取它，不要把值本身粘贴到对话中。通过 MCP 使用时会扣费吗？
如果图片未能在 45 秒内就绪怎么办？
generate_image 工具会返回任务 id，并提示使用 get_creation。请用这个 id 查询它，不要重新发起生成：新的请求就是新的扣费。