API Reference
Use the rendering hub to pick the right render workflow fast
The rendering surface covers individual PDF renders, accepted render jobs, batch workflows, and the shared PDF options object used across those requests. Start here when your task belongs to rendering and you want the right reference page first.
The machine readable contract for this runtime surface lives in /docs. This rendering hub stays broader and more guided so you can understand how the route families fit together before dropping into raw request and response schemas.
Credential
Use the X-API-Key header for the rendering surface.
Core split
Single render can complete now or return accepted work that needs follow up.
Scale path
Batch starts as accepted work and always expects later status checks.
Route Families
Open the rendering page that matches the workflow you are building
Treat accepted jobs as their own route family, not a side note under create routes. Use this hub to move directly to the canonical page for your current task.
Follow accepted work
Accepted render jobs
Use the jobs page for status polling, terminal-state interpretation, retry signals, and file retrieval after a render returns accepted work.
Create one render
Single render
Use the create contract for HTML, URL, or template input, output modes, sync behavior, and accepted-response handling.
Queue many renders
Batch rendering
Use the batch page for create semantics, progress tracking, per-item retrieval, zip downloads, and callback workflows.
Shared render object
PDF options
Use one shared reference for layout, timing, watermark, metadata, and runtime controls used across rendering routes.
Next Step
Choose one page based on what you need to do right now
Choose the route that matches your immediate decision: follow accepted work, create one render, run a batch, or tune shared render controls.
- Open Accepted render jobs when your main problem is tracking an accepted render through status and file retrieval.
- Open Single render when you are creating one PDF and need the main request contract.
- Open Batch rendering when one workflow needs many PDFs, progress tracking, zip retrieval, callbacks, or cancellation.
- Open PDF options when you already have a working render flow and want stronger control over layout, timing, watermarking, metadata, or runtime behavior.