Guides
Choose the right implementation guide and ship the task in front of you
Use this hub to route quickly by job, not by endpoint list. Each guide is a task-based implementation path with sequencing, decision points, and failure handling kept in one place. Across the section, guides now aim to show the easiest safe path first, then a realistic production path, then the advanced edge when it belongs to the workflow.
Recommended path
- Pick one guide that matches your current delivery task.
- Run that workflow start to finish before mixing in another guide.
- Use reference pages only when you need exact request or response contracts.
Start here if
You know the implementation outcome and want the fastest safe path to working behavior.
Default first guide
Accepted render flow for the normal single render success path that continues through status and file routes.
Guide promise
One canonical guide per task, with links out instead of duplicated route contracts.
Example range
Expect a ladder from first working request to realistic rollout patterns and advanced capability where supported.
Start Here
Route by your delivery stage, not just by route family
Pick one path by immediate scope and current maturity. Start with the smallest implementation guide that fits your task, then move into operational or advanced workflow guides only when your integration needs them.
First Implementation
Best first guides when you are getting the workflow working end to end
Accepted render flow
You are handling accepted single render retrieval
Start with the normal accepted success path, then learn polling, retry signals, and safe final retrieval.
Template rendering
You want reusable document layouts
Start with one saved template and one runtime data payload, then grow into version pinning and accepted follow up.
Operational Maturity
Best guides when the happy path works and your next job is reliability
Retry safety
You need safe create route retry behavior
Standardize idempotency, bounded retries, and replay decisions before load or network ambiguity exposes duplicate-work risk.
Credential lifecycle
You need a safe credential lifecycle
Move from one-time manual key changes into repeatable rotation, validation, and incident recovery practices.
Launch readiness
You are preparing for production launch
Use one launch-readiness path for credentials, retries, limits, monitoring, and release control before full traffic.
Advanced Workflow Complexity
Best guide when the workflow itself has more moving parts
Guide Directory
Canonical implementation guides across the full spectrum
Use this directory when you already know the task category and want the canonical guide for that workflow.
Accepted render flow
Best default first guide for accepted single render work, from first 202 through polling and retrieval.
Render from template
Best first guide for reusable layouts, from saved template basics through version-aware rendering.
Batch with webhooks
Best advanced workflow guide for async batch processing with callback handling, reconciliation, and recovery.
Retries and idempotency
Best reliability guide for duplicate-safe create retries across single and batch workflows.
Key rotation and recovery
Best credential-operations guide for planned rotation, lost-secret recovery, and compromise response.
Production hardening playbook
Best launch-readiness guide for turning a working integration into a monitored and supportable production system.