Fetch recipient preview

Download a rendered PNG preview when your integration needs to show or store the generated recipient artwork.

GET https://platform.scribeless.co/api/recipients/{recipientId}/preview

Headers

X-API-Key: YOUR_API_KEY

Path parameters

Query parameters

The preview endpoint downloads PNG previews. Do not send a format parameter.

Example request

curl --location 'https://platform.scribeless.co/api/recipients/RECIPIENT_ID/preview?type=postcard&page=0' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --output preview.png

Finding the right preview

Create-recipient responses do not include preview URLs. To fetch a preview:

1. Create the recipient.
2. Fetch the recipient with GET /api/recipients/{recipientId}.
3. Check that is_rendered is true and find a documents entry with format: "preview".
4. Use the document type and page number with this preview endpoint.

For a preview document like this:

{
  "format": "preview",
  "src": "teams/TEAM_ID/campaigns/CAMPAIGN_ID/recipients/RECIPIENT_ID/postcard-1.png",
  "document": {
    "type": "postcard"
  }
}

Call:

GET /api/recipients/RECIPIENT_ID/preview?type=postcard&page=0

The page query parameter is zero-indexed, so postcard-1.png is fetched with page=0.

Status codes