PolarBanner

Docs & Guides

API Reference

Review endpoint behavior, request fields, response shapes, authentication, idempotency, and error handling.

Read the Docs

API Reference workflow

API Reference is set up for teams that need repeatable, template-driven output instead of one-off manual design work.

  • ✓Connect API reference to uploaded assets, approved templates, and API-safe render jobs.
  • ✓Keep all remote image dependencies blocked so production renders use controlled assets only.
  • ✓Use idempotency keys when the same request can be retried by an automation tool.

What this page covers

Review endpoint behavior, request fields, response shapes, authentication, idempotency, and error handling.

  • ✓Keep client code aligned with documented contracts.
  • ✓Use idempotency keys for retryable render requests.
  • ✓Treat API keys as secrets and never expose them in browser code.

Production checklist

Before using this workflow in a campaign, validate the template, expected dimensions, asset ownership, and output access path.

  • ✓Render the same payload three times and compare output hashes for deterministic behavior.
  • ✓Confirm local fonts are present in the approved whitelist before launch.
  • ✓Monitor completed and failed jobs from the logs page during rollout.