Developer Tools

API Documentation

Integrate beautifully styled review images into your application with a single POST request.

Generate Image

POSThttps://aesthetic-proof.gooder.games/api/v1/generate

Consumes 1 Credit

Returns a beautifully styled PNG image stream representing the review card. The default dimensions are 1200x630, or 840x460 if compact mode is enabled.

Request Headers

Header	Required	Description
Authorization	Yes	Format: `Bearer ap_your_secret_key`
Content-Type	Yes	Must be `application/json`

JSON Body Parameters

name

stringRequired

Customer's full name (e.g. 'Jane Doe').

text

stringRequired

The review or testimonial text.

handle

string

Customer's social media handle (e.g. '@janedoe').

avatar_url

string

Direct public URL to the customer's avatar. Must be accessible to the Edge runtime.

rating

number

Rating from 1 to 5. Will display as visual stars on the card.

theme

string

'light' | 'dark' | 'transparent'. Defines the base contrast handling.

compact

boolean

If true, crops the image bounding box to 840x460, ideal for responsive embedding.

preset

string

Applies a pre-defined aesthetic override. Choose from: 'midnight', 'frost', 'sunset', or 'minimal'.

styles Object (Optional)

Deep CSS-like customization. All properties are optional. If provided, overrides preset aesthetics.

cardBackground	string	Hex or rgba format (e.g., 'rgba(255,255,255,0.1)')
textColor	string	Hex or rgba format
secondaryTextColor	string	Hex or rgba format
accentColor	string	Hex or rgba format (Used for stars and verified badges)
borderColor	string	Hex or rgba format
borderRadius	number	Corner radius in pixels (e.g., 24)
elevation	number	Pre-defined shadow strengths (0, 1, 2, or 3)

Responses & Status Codes

200 OKimage/png

Returns the binary PNG representation of the generated card.

400 Bad Requestapplication/json

The JSON payload is malformed or missing required parameters.

401 Unauthorizedapplication/json

The Authorization header is missing, or the API key format is invalid.

402 Payment Requiredapplication/json

Your credit balance is 0. Please refill your account on the dashboard.

No-Code & Zapier Integration

You do not need to write code to use Aesthetic Proof. You can automatically generate images whenever a user submits a Google Form, Typeform, or Stripe purchase using **Zapier** or **Make.com**.

Trigger: Set up your trigger step (e.g., "New Typeform Entry").
Action: Add a Webhooks by Zapier step and choose Custom Request.
Method: POST
URL: https://aesthetic-proof.gooder.games/api/v1/generate
Data: Pass standard JSON linking your trigger variables (e.g., { "name": "1. Name", "text": "1. Feedback" }).
Headers: Add Authorization mapped to Bearer ap_your_api_key.
Result: Zapier will output a binary file object which you can pipe directly into a Google Drive folder or a Slack message!

Quick Examples

curl -X POST https://api.aesthetic-proof.gooder.games/v1/generate \
  -H "Authorization: Bearer ap_your_secret_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Jane Doe",
    "text": "Aesthetic Proof is simply amazing!",
    "preset": "midnight"
  }' \
  --output feedback.png

Integration Architecture

Because the API requires an Authorization secret, do not call it directly from a frontend <img src="..."> tag. Doing so exposes your secret key.

Action: Always proxy the request through your own secure backend API, or generate and cache the images in an S3 bucket.