文档
获取 PDF
GET/generations/{id}/pdf
文档的 PDF,在我们的服务器上只渲染一次,以短期有效的下载 URL 返回。如果尚未存储,该调用会按需渲染并在完成后返回,通常只需几秒;如果其他地方已在渲染,则返回 202,稍后再次请求即可。
参数
| 名称 | 类型 | 说明 |
|---|---|---|
id必填 | uuid | 文档的 ID。 |
download | 1 | 将 URL 变为以文档命名的附件。 |
redirect | 1 | 返回指向该 URL 的 302,而不是 JSON。 |
请求
curl "https://usepaperclerk.com/api/v1/generations/9b8e2f10-5c4d-4e3f-8a7b-6c5d4e3f2a1b/pdf?download=1" \
-H "Authorization: Bearer pc_YOUR_TOKEN"响应
JSON
{
"status": "ready",
"url": "https://…/generation-pdfs/…/9b8e2f10-5c4d-4e3f-8a7b-6c5d4e3f2a1b.pdf?token=…",
"pages": 2,
"expires_in": 60
}- URL 在 expires_in 秒后失效。请重新请求,而不要保存它。
- 渲染失败会返回 500 和 pdf_render_failed;再次请求会重试。