Starter templates to copy: social cards, a ticket with a QR code, a certificate, a video thumbnail

GET/v1/starters

Each starter is a complete template with {{placeholders}} and sample variables. Render one inline by passing its template to POST /v1/images, or save your own copy with POST /v1/templates and change it from there.

In the full reference

REQUEST

curl "https://api.imageapis.com/v1/starters" \
  -H "X-API-Key: YOUR_KEY"

import requests

r = requests.get("https://api.imageapis.com/v1/starters", headers={"X-API-Key": "YOUR_KEY"})
print(r.status_code, r.headers.get("X-Gw-Remaining"))
print(r.json())

const r = await fetch("https://api.imageapis.com/v1/starters", {
  headers: { "X-API-Key": "YOUR_KEY" }
});
console.log(r.status, r.headers.get("X-Gw-Remaining"));
console.log(await r.json());

RESPONSE

200OK

{
  "starters": [
    {
      "slug": "og-card",
      "name": "Open Graph card",
      "description": "Site name, tag, a title that shrinks to fit, a description and an accent bar. The design behind POST /v1/og, as a template you can change.",
      "tags": [
        "social",
        "og"
      ],
      "width": 1200,
      "height": 630,
      "layers": 5,
      "variables": [
        "title",
        "description",
        "site",
        "tag"
      ]
    },
    {
      "slug": "event-ticket",
      "name": "Event ticket with QR",
      "description": "A wide ticket: event, date and venue on the left, the holder's name and seat, a perforation, and a QR code of the ticket URL on the right.",
      "tags": [
        "ticket",
        "qr",
        "pdf"
      ],
      "width": 1000,
      "height": 400,
      "layers": 10,
      "variables": [
        "event",
        "date",
        "venue",
        "name",
        "seat",
        "ticket_url"
      ]
    }
  ]
}

401Missing or invalid API key (from the gateway)

429Plan ceiling or rate limit reached; see X-Gw-Reset (from the gateway)

Try it — sign in first