Flask

Put the render call behind a Flask view and your API key never reaches the browser. Imejis returns the finished image directly in the response, so the handler is a single upstream request, with nothing to poll and no webhook to receive.

Set two environment variables first: IMEJIS_API_KEY (from your dashboard) and IMEJIS_DESIGN_ID (any design's id). The fields you override are component.property pairs: headline.text, title.color, image.image; only what you send changes, and a design's overridable fields are listed in its Share / API panel.

Each route below comes from a real Flask app that is booted in Docker and called end to end before this page ships.

An endpoint that returns the generated imageAn endpoint that returns the generated image

A route in your app that renders on demand and streams the image straight back, so your render key never reaches the browser. This is the shape to use behind an <img src> on a page you control. ?format= picks png, jpeg, webp or pdf, and the route answers with the content type that matches it. A PDF labelled image/png is a file the browser, the email client and Slack all refuse to open.

Flask: An endpoint that returns the generated image

import os
 
import requests
from flask import Flask, Response, jsonify, request
 
app = Flask(__name__)
 
API_KEY = os.environ["IMEJIS_API_KEY"]
DESIGN_ID = os.environ["IMEJIS_DESIGN_ID"]
BASE = os.environ.get("IMEJIS_RENDER_URL", "https://render.imejis.io")
HEADERS = {"dma-api-key": API_KEY, "Content-Type": "application/json"}
 
# The formats the render API accepts. The routes below pass `?format=` through
# when one is asked for; with none, the render host's default (jpeg) applies.
FORMATS = ("png", "jpeg", "webp", "pdf")
 
# Render on demand and stream the image straight back. The render key stays on
# the server, so it never reaches the browser — point an <img src> at this.
#
# `?format=` decides what comes back — png · jpeg · webp · pdf — and with no
# format the render host's default (jpeg) applies. Either way the response
# carries whatever type the render API set, passed straight through: a PDF
# labelled `image/jpeg` is a file the browser, the email client and Slack all
# refuse to open.
 
 
@app.get("/og")
def og_image():
    requested = request.args.get("format", "")
    params = {"format": requested} if requested in FORMATS else {}
 
    upstream = requests.post(
        f"{BASE}/v1/{DESIGN_ID}",
        headers=HEADERS,
        params=params,
        json={
            "headline.text": request.args.get("title", "Hello from Flask"),
            "subtitle.text": request.args.get("subtitle", ""),
        },
    )
    if not upstream.ok:
        return jsonify(error=f"render failed: {upstream.status_code}"), 502
    return Response(
        upstream.content,
        mimetype=upstream.headers.get("content-type", "image/jpeg"),
        # Renders are deterministic, so cache aggressively at the edge/CDN —
        # and every request to the render API is one metered render.
        headers={"Cache-Control": "public, immutable, no-transform, max-age=31536000"},
    )
 
 
if __name__ == "__main__":
    app.run(port=3000)

One endpoint every size and jpeg qualityOne endpoint, every size, and JPEG quality

A multi-size design carries several canvases: an OG image, a square post, a vertical story. ?variation=<id> picks which one the route renders, and omitting it gives the base size, so one endpoint serves every size your pages ask for. ?quality= trades file size for fidelity on JPEG only; png, webp and pdf ignore it.

Flask: One endpoint, every size, and JPEG quality

import os
 
import requests
from flask import Flask, Response, jsonify, request
 
app = Flask(__name__)
 
API_KEY = os.environ["IMEJIS_API_KEY"]
DESIGN_ID = os.environ["IMEJIS_DESIGN_ID"]
BASE = os.environ.get("IMEJIS_RENDER_URL", "https://render.imejis.io")
HEADERS = {"dma-api-key": API_KEY, "Content-Type": "application/json"}
 
# The formats the render API accepts. The routes below pass `?format=` through
# when one is asked for; with none, the render host's default (jpeg) applies.
FORMATS = ("png", "jpeg", "webp", "pdf")
 
# One design, several canvases — an OG image, a square post, a vertical
# story. `?variation=<id>` picks which one you get; with none you get the
# base size. Map YOUR OWN size names to the ids (the design's Share / API
# panel lists them) so a page asks for "story", not for an id.
#
# `?quality=` trades file size for fidelity on JPEG only — png, webp and pdf
# ignore it.
SIZES = {"og": None, "story": os.environ.get("IMEJIS_VARIATION_ID", "story")}
 
 
@app.get("/og-size")
def og_size():
    size = request.args.get("size", "og")
    if size not in SIZES:
        return jsonify(error=f"unknown size: {size}"), 404
 
    params = {}
    if SIZES[size]:
        params["variation"] = SIZES[size]
    requested = request.args.get("format", "")
    if requested in FORMATS:
        params["format"] = requested
    quality = request.args.get("quality", type=int)
    if quality and 1 <= quality <= 100:
        params["quality"] = quality
 
    upstream = requests.post(
        f"{BASE}/v1/{DESIGN_ID}",
        headers=HEADERS,
        params=params,
        json={"headline.text": request.args.get("title", "Every size")},
    )
    if not upstream.ok:
        return jsonify(error=f"render failed: {upstream.status_code}"), 502
    return Response(
        upstream.content,
        mimetype=upstream.headers.get("content-type", "image/jpeg"),
        headers={"Cache-Control": "public, immutable, no-transform, max-age=31536000"},
    )
 
 
if __name__ == "__main__":
    app.run(port=3000)

An endpoint that returns a hosted or signed image urlAn endpoint that returns a hosted or signed image URL

Ask for ?delivery=hosted (a public URL) or ?delivery=signed (a private, expiring one) and hand the URL to the caller instead of the bytes, which is what you want for an email, a webhook payload, or a share card.

Flask: An endpoint that returns a hosted or signed image URL

import os
 
import requests
from flask import Flask, Response, jsonify, request
 
app = Flask(__name__)
 
API_KEY = os.environ["IMEJIS_API_KEY"]
DESIGN_ID = os.environ["IMEJIS_DESIGN_ID"]
BASE = os.environ.get("IMEJIS_RENDER_URL", "https://render.imejis.io")
HEADERS = {"dma-api-key": API_KEY, "Content-Type": "application/json"}
 
# The formats the render API accepts. The routes below pass `?format=` through
# when one is asked for; with none, the render host's default (jpeg) applies.
FORMATS = ("png", "jpeg", "webp", "pdf")
 
# Ask for a stored URL instead of bytes. `hosted` is public and permanent;
# `signed` is private and expires (`expiresIn` is minutes).
@app.get("/og-url")
def og_url():
    delivery = "signed" if request.args.get("private") else "hosted"
    params = {"delivery": delivery}
    # The stored URL carries the extension of the format it was rendered in,
    # so pass the format through here too — a recipient that sniffs by
    # extension (an email client, a Slack unfurl) needs `.pdf` to say pdf.
    requested = request.args.get("format", "")
    if requested in FORMATS:
        params["format"] = requested
    if delivery == "signed":
        params["expiresIn"] = 30
 
    upstream = requests.post(
        f"{BASE}/v1/{DESIGN_ID}",
        headers=HEADERS,
        params=params,
        json={"headline.text": request.args.get("title", "Shared card")},
    )
    stored = upstream.json()
    return jsonify(
        url=stored["url"], format=stored.get("format"), expiresAt=stored.get("expiresAt")
    )
 
 
if __name__ == "__main__":
    app.run(port=3000)

Bulk image generation from a routeBulk image generation from a route

One POST to /bulk renders many images, a row per record or one per size, and returns a URL for each, in the order you sent them.

Flask: Bulk image generation from a route

import os
 
import requests
from flask import Flask, Response, jsonify, request
 
app = Flask(__name__)
 
API_KEY = os.environ["IMEJIS_API_KEY"]
DESIGN_ID = os.environ["IMEJIS_DESIGN_ID"]
BASE = os.environ.get("IMEJIS_RENDER_URL", "https://render.imejis.io")
HEADERS = {"dma-api-key": API_KEY, "Content-Type": "application/json"}
 
# The formats the render API accepts. The routes below pass `?format=` through
# when one is asked for; with none, the render host's default (jpeg) applies.
FORMATS = ("png", "jpeg", "webp", "pdf")
 
# One POST renders many images and returns a URL for each, in the order sent —
# a row per record, or one per size.
@app.post("/cards")
def cards():
    rows = (request.get_json(silent=True) or {}).get("rows", [])
    upstream = requests.post(
        f"{BASE}/bulk",
        headers=HEADERS,
        json={
            "designId": DESIGN_ID,
            "delivery": "hosted",
            "format": "png",
            "data": [
                {"headline.text": row["name"], "subtitle.text": row["role"]}
                for row in rows
            ],
        },
    )
    bulk = upstream.json()
    return jsonify(
        summary=bulk["summary"],
        urls=[item.get("url") for item in bulk["results"]],
    )
 
 
if __name__ == "__main__":
    app.run(port=3000)

Using the image url directly in a templateUsing the image URL directly in a template

For a public design you can skip the proxy entirely and point an <img> at the render URL with the field values in the query string. Keep the proxy when the key must stay private. That is the right default.

Flask: Using the image URL directly in a template

import os
 
import requests
from flask import Flask, Response, jsonify, request
 
app = Flask(__name__)
 
API_KEY = os.environ["IMEJIS_API_KEY"]
DESIGN_ID = os.environ["IMEJIS_DESIGN_ID"]
BASE = os.environ.get("IMEJIS_RENDER_URL", "https://render.imejis.io")
HEADERS = {"dma-api-key": API_KEY, "Content-Type": "application/json"}
 
# The formats the render API accepts. The routes below pass `?format=` through
# when one is asked for; with none, the render host's default (jpeg) applies.
FORMATS = ("png", "jpeg", "webp", "pdf")
 
# For a PUBLIC design you can skip the proxy and point an <img> straight at the
# render URL. Keep the proxy whenever the key must stay private — that is the
# right default, and what /og above is for.
@app.get("/card")
def card():
    url = requests.Request(
        "GET",
        f"{BASE}/v1/{DESIGN_ID}",
        params={
            "dma-api-key": API_KEY,
            "format": "png",
            "headline.text": request.args.get("title", "Straight from a URL"),
        },
    ).prepare().url
    return f'<img src="{url}" width="1200" height="630" alt="Generated card" />'
 
 
if __name__ == "__main__":
    app.run(port=3000)

The response is the raw image (`image/jpeg` by default). Choose the format with `?format=png|jpeg|webp|pdf` (default jpeg) and set JPEG quality with `?quality=1-100`. Store the result and get a URL back with `?delivery=hosted` (or `?delivery=signed&expiresIn=60`), and render a specific size of a multi-size design with `?variation=<id>`.

Parameter	Values	Default	What it does
`?format=`	png · jpeg · webp · pdf	jpeg	Output image format.
`?quality=`	1–100	none	Compression quality for lossy output; ignored for other formats. (JPEG only)
`?delivery=`	stream · hosted · signed	stream	stream = raw image bytes (default); hosted = store + return a public URL; signed = store + return a time-limited URL.
`?expiresIn=`	minutes	60	Signed-URL lifetime in minutes (default 60, max 10080 = 7 days). (delivery=signed only)
`?variation=`	<size id>	master	Which multi-dimension SIZE to render. Omit or use "master" for the base size; an unknown id falls back to the master. (multi-size designs only)

PNG (?format=png): Lossless, supports transparency. Largest file.
JPEG (?format=jpeg): Smaller, lossy, no transparency. Quality adjustable.
WebP (?format=webp): Smallest, supports transparency. Modern browsers.
PDF (?format=pdf): Vector page, for print and documents.

See the delivery modes and generate images with the API guides.

The framework-free version is on the Python page, and FastAPI is the same five handlers written async. requests.post blocks the worker for the length of the render, so size your worker count for the renders you expect to run at once. Each view call is one render, so cache what you serve; 100 renders a month are free, and pricing covers the rest.