An API to programatically generate memes based solely on requested URLs.

Build Status Coverage Status Swagger Validator License GitHub Sponsora

Generating Images

The API is stateless so URLs contain all the information necessary to generate meme images. For example, produces:

Sample Image

Special Characters

In URLs, spaces can be inserted using underscores, dashes, or mixed case:

  • underscore (_) → space ( )
  • dash (-) → space ( )
  • 2 underscores (__) → underscore (_)
  • 2 dashes (--) → dash (-)

Reserved URL characters can be escaped:

  • tilde + Q (~q) → question mark (?)
  • tilde + P (~p) → percentage (%)
  • tilde + H (~h) → hashtag/pound (#)
  • tilde + S (~s) → slash (/)
  • 2 single quotes ('') → double quote (")

For example, produces:

Escaped Characters

Alternate Styles

Some memes come in multiple forms, which can be selected via ?style=<style>.

For example, these are two styles provided by the template:

/images/ds.png /images/ds.png?style=maga

Custom Backgrounds

You can also use your own image URL as the background. For example, produces:

Custom Background

Image Sizing

Images can be scaled to a specific width via ?width=<int> or a specific height via ?height=<int>. If both parameters are provided (?width=<int>&height=<int>), the image will be padded to the exact dimensions.

For example, produces:

Custom Size

Clients can also request .jpg instead of .png for smaller files.

API Documentation

The full interactive documentation is available here:

Here are some sample clients to explore:

Platforms Link Source
Slack --- Python: nicolewhite/slack-meme
Slack --- Go: CptSpaceToaster/slackbot
Slack ---
Hain --- JavaScript: Metrakit/hain-plugin-meme
Web --- Clojure: jasich/mighty-fine-memes
Web, Slack ---
Discord --- JavaScript:

Additional clients can be found by searching for code examples on GitHub.