Images

Display a template background

Changed on
get/images/{template_filename}

Request

  • Base URL
    https://api.memegen.link (the document declares no server; this is the origin it was published from)
  • URL
    https://api.memegen.link/images/{template_filename}
  • Auth
    API key in header X-API-KEY

Path parameters

template_filenamestring required

Template ID and image format: <template_id>.<extension>. This is the canonical empty-template render and matches the blank field on GET /templates/{id}. Use this when a client just wants the background. The same query parameters as /images/{template_id}/{text_filepath} apply.

Query parameters

statusinteger

Override the HTTP response status code. Primarily used internally by the POST /images/ → redirect flow to propagate a 201 Created semantic to the final image fetch. Most clients should not need to set this directly.

framesinteger

Maximum number of frames to render in animated output. 0 (default) means no cap. Use this to bound response size and render time on long animations.

scalenumber float

Multiplier applied to the overlay's default size. Most useful with style=<url>.

centerstring

Comma-separated <x>,<y> fractional coordinates (0.0–1.0) for overlay center within its slot. Most useful with style=<url>.

backgroundstring

Custom background image URL. Composes with style=<url> overlays.

colorstring

Comma-separated <text>,<outline> pair. Each value is an HTML color name or hex code (with or without a leading #).

heightinteger

Output height in pixels. See width for combined behavior.

widthinteger

Output width in pixels. If both width and height are supplied, the image is padded to fit while preserving aspect ratio. Values between 1 and 9 are rejected with HTTP 422.

layoutstring

Text layout: default or top. The top layout places all text at the top of the image rather than in the template's default text regions.

fontstring

Font id or alias overriding the template default (GET /fonts/). Unknown values return HTTP 422; the image still renders with the template default font.

stylestring

Alternate visual variant from the template's styles array, OR an HTTPS URL to use as a custom overlay image. For templates with overlays > 1, may be repeated to set each slot independently. Unknown style names return HTTP 422, not the default render.

Response

Successfully displayed a template background

Changes

    • info

      added the new optional query request parameter background

    • info

      added the new optional query request parameter center

    • info

      added the new optional query request parameter color

    • info

      added the new optional query request parameter font

    • info

      added the new optional query request parameter frames

    • info

      added the new optional query request parameter height

    • info

      added the new optional query request parameter layout

    • info

      added the new optional query request parameter scale

    • info

      added the new optional query request parameter status

    • info

      added the new optional query request parameter style

    • info

      added the new optional query request parameter width

    • info

      api operation id get~images.detail_blank removed and replaced with get~Images.detail_blank

    • info

      api tag Images added

    • info

      api tag images removed