Render PDF asynchronously
render_asyncQueue one PDF render and return immediately with { jobId, status: 'queued' } instead of waiting for the document. Choose this over render_pdf when blocking is not acceptable — a heavy template, a large data set, or a turn where you have other work to do — and poll get_job with the returned jobId until status is 'completed' (the finished render, including its download URL, arrives on the job) or 'failed'. Choose render_pdf when a single document is small enough that waiting a few seconds is fine and you want the URL in one call, and render_batch when you have many documents to make at once. Same template, data and page options as render_pdf, and the same one render from the monthly quota — the quota is checked when the job is accepted, so an over-quota call fails here with 402 rather than silently queueing.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | Data used to populate the template. | |
| name | No | Your own label for this document. Echoed back on the job result and stored on the render, so list_renders can be grepped by it later. | |
| pdf_a | No | Convert the output to a PDF/A archival conformance level. | |
| format | No | Paper size. Defaults to a4. | |
| margin | No | CSS lengths, e.g. { top: '20mm', bottom: '20mm' }. | |
| metadata | No | PDF document properties written into the file's metadata dictionary. | |
| template | Yes | Template slug (e.g. 'invoice') or template UUID. Same values render_pdf accepts. | |
| watermark | No | Draws your own diagonal watermark over every page. Unrelated to the free-plan Kamy watermark, which is applied regardless — see get_account.watermarkPolicy. |