GET/v1/starters/{slug}
One starter template with its layers and sample variables
PARAMETERS
- slugpath · stringREQUIRED
- The starter's sluge.g. event-ticket
REQUEST
curl "https://api.imageapis.com/v1/starters/event-ticket" \ -H "X-API-Key: YOUR_KEY"
import requests
r = requests.get("https://api.imageapis.com/v1/starters/event-ticket", 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/event-ticket", {
headers: { "X-API-Key": "YOUR_KEY" }
});
console.log(r.status, r.headers.get("X-Gw-Remaining"));
console.log(await r.json());
RESPONSE
200OK
{
"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": "Ship social cards without a designer",
"description": "One request, one hosted image.",
"site": "example.com",
"tag": "Blog"
},
"template": {
"name": "Open Graph card",
"width": 1200,
"height": 630,
"background": "#0b1220",
"layers": [
{
"name": "site",
"type": "text",
"x": 72,
"y": 72,
"width": 800,
"height": 40,
"text": "{{site}}",
"font": "Inter",
"weight": 600,
"size": 28,
"color": "#a3b1c6",
"valign": "middle"
},
{
"name": "tag",
"type": "text",
"x": 72,
"y": 150,
"width": 800,
"height": 32,
"text": "{{tag}}",
"font": "Inter",
"weight": 700,
"size": 22,
"color": "#6366f1",
"transform": "uppercase",
"letter_spacing": 2
},
{
"name": "title",
"type": "text",
"x": 72,
"y": 196,
"width": 1056,
"height": 230,
"text": "{{title}}",
"font": "Inter",
"weight": 800,
"size": 72,
"color": "#ffffff",
"valign": "bottom",
"line_height": 1.08,
"fit": "shrink",
"max_lines": 3,
"letter_spacing": -1
},
{
"name": "description",
"type": "text",
"x": 72,
"y": 442,
"width": 1056,
"height": 100,
"text": "{{description}}",
"font": "Inter",
"weight": 400,
"size": 30,
"color": "#a3b1c6",
"fit": "shrink",
"max_lines": 2,
"line_height": 1.35
},
{
"name": "accent",
"type": "rect",
"x": 0,
"y": 616,
"width": 1200,
"height": 14,
"fill": "#6366f1"
}
]
}
}