images

Sign a GET render URL (for <meta og:image>)

post/v1/embed-url

Request

  • Base URL: https://api.propzapi.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.propzapi.com/v1/embed-url
  • Auth: none declared

Headers

x-api-keystring

Request body

templatestring required

Built-in id (e.g. og-article) or one of your tpl_… ids.

modificationsobject

variable → value overrides; omitted variables use the template default.

format'png' | 'jpeg' | 'webp' | 'pdf'
scaleinteger
qualityinteger

For jpeg / webp.

verifystring[]

Strings that must render as visible text. The response adds verified (all landed) and checks (per-string found / clipped), so you can confirm the exact values made it into the image.

receiptboolean

Return a receipt object: image_sha256, the text that actually rendered, per-string checks + misses, viewport, and timing — enough to trust the render without inspecting pixels.

privateboolean

Keep this render OUT of the public bucket. The response url is a signed link that expires (for invoices, receipts, anything with PII). Not cached.

private_ttlinteger

Lifetime of the signed private URL in seconds (60 = 1 min, 604800 = 7 days). Only applies when private is true.

Example request

{
  "template": "og-article",
  "format": "png",
  "modifications": {
    "title": "How we cut render costs by 95%",
    "eyebrow": "ENGINEERING"
  },
  "verify": [
    "How we cut render costs by 95%"
  ],
  "receipt": true
}

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.