Memes

A meme is an image, video or audio file you save to your account. Fluxer keeps its own copy, so the meme still works after the source message or URL is gone. Bot tokens get 403 ACCESS_DENIED on these routes, and you send a saved meme with favorite_meme_id in Create message.

Limits

You can save up to max_favorite_memes memes (default 50) with up to max_favorite_meme_tags tags each (default 10). See instance limits. Fluxer compares the stored bytes, so saving a file you already have returns MEDIA_ALREADY_IN_FAVORITE_MEMES, even from a different URL or message.

Meme object

A meme object is one saved file. You can change only name, alt_text and tags after you save it.

Structure

Field	Type	Description
id	snowflake	The ID of the meme
user_id	snowflake	The ID of the owning account
name	string	The display name of the meme (1-100 characters)
alt_text	?string	The accessibility description of the media
tags	array[string]	The search tags, each 1-30 characters
attachment_id	snowflake	The ID of the attachment holding the stored copy
filename	string	The filename of the stored copy
content_type	string	The MIME type of the stored copy
content_hash	?string	The content hash used for duplicate checks
size	integer	The size of the copy in bytes
width	?integer	The width of the media in pixels
height	?integer	The height of the media in pixels
duration	?number	The duration of the media in seconds
url1	string	The signed attachment URL of the stored copy
is_gifv	boolean	Whether the media is animated or a video converted from a GIF
gif_slug2	?string	The provider slug the meme came from
gif_provider2	?string	The name of the GIF provider that issued gif_slug
media3	?map[string, GIF media format object]	The provider formats for a GIF-sourced meme
placeholder	?string	The thumbhash placeholder recorded at save time

¹ A new signed attachment URL on every read

² Both are set or both are null. The value is klipy or tenor

³ Set only by Save meme from URL

Example

{
  "id": "1501314428688998182",
  "user_id": "1501314428688990000",
  "name": "party_parrot.gif",
  "alt_text": null,
  "tags": ["parrot", "party"],
  "attachment_id": "1501314428688998183",
  "filename": "party_parrot.gif",
  "content_type": "image/gif",
  "size": 40213,
  "url": "https://media.example.com/attachments/1501314428688998182/1501314428688998183/party_parrot.gif?ex=69fba4b5&is=69fa5335&hm=5586be3ae70411fe6582431649e2f28abc6c201e4f12a4f43a3256b72b90d3de",
  "content_hash": "b3f1c2e4a5d6978812ab34cd56ef7890",
  "width": 320,
  "height": 240,
  "duration": null,
  "is_gifv": true,
  "gif_slug": "party-parrot-1234",
  "gif_provider": "klipy",
  "placeholder": "3PcNNYYONWQPFxrsUeUcRh4"
}

GIF media format object

A GIF media format object is one size and file type of a provider GIF.

Structure

Field	Type	Description
src	string	The direct media URL of this format
proxy_src	string	The Media Proxy URL of this format
width	integer	The width in pixels
height	integer	The height in pixels

GIF media format names

Value	Description
webm	Full-size WebM video
mp4	Full-size MP4 video
webp	Full-size WebP image
gif	Full-size GIF image
mediumwebm	Medium WebM video
mediummp4	Medium MP4 video
mediumwebp	Medium WebP image
mediumgif	Medium GIF image
tinywebm	Small WebM video
tinymp4	Small MP4 video
tinywebp	Small WebP image
tinygif	Small GIF image
nanowebm	Smallest WebM video
nanomp4	Smallest MP4 video
nanowebp	Smallest WebP image
nanogif	Smallest GIF image
loopedmp4	Looping MP4 video

A map has only the formats the provider returned. Use the first format from your own order of preference that the map has.

Resolved GIF entry object

One entry for one URL submitted to Resolve GIF URLs.

Structure

Field	Type	Description
url1	string	The source GIF URL
proxy_url	string	The signed Media Proxy URL for the preview format
width2	integer	The width of the preview format in pixels
height2	integer	The height of the preview format in pixels
media3	map[string, GIF media format object]	The formats for the URL, keyed by format name
content_type4	string	The MIME type of the media at proxy_url
placeholder	?string	The thumbhash placeholder

¹ The provider's canonical URL when the provider recognizes the URL, and the submitted URL otherwise

² Zero when unknown

³ Empty when Fluxer can't find the GIF

⁴ Empty when unknown. Treat an empty value as image/gif

List memes

GET/v1/users/@me/memes

Returns your memes, newest first.

Response

Status	Body	Condition
200	array[meme object]	The collection was returned

The rate limit is 60 requests per 10 seconds, on the favorite_meme:list bucket.

Save meme from URL

POST/v1/users/@me/memes

Fetches a media URL, stores a copy and returns the new meme. Sends Favorite Meme Create.

JSON body

Field	Type	Description
url	string	The absolute media URL to fetch and store
name?1	?string	The display name of the meme (1-100 characters)
alt_text?	?string	The accessibility description of the media (0-500 characters)
tags?	?array[string]	The search tags to store, each 1-30 characters
gif_slug?2	?string	The provider slug or slug-id token for the GIF (1-300 characters)
gif_provider?2	?string	The name of the provider that issued gif_slug (1-32 characters)
media?3	?map[string, GIF media format object]	The provider formats captured at save time

¹ Defaults to the stored filename, truncated to 100 characters

² Used only when both are set and gif_provider matches the provider configured on the instance. Otherwise Fluxer reads the slug from url

³ Stored only when the URL resolved to a provider GIF and the map is not empty

Response

Status	Body	Condition
201	meme object	The meme was created
400	error response	INVALID_FORM_BODY when the body is invalid, as with MAX_FAVORITE_MEME_TAGS_EXCEEDED or MEDIA_ALREADY_IN_FAVORITE_MEMES
400	error response	MEDIA_METADATA_ERROR when the URL has no usable media
400	error response	MAX_FAVORITE_MEMES when the collection is full

The rate limit is 20 requests per minute, on the favorite_meme:create:url bucket.

Save meme from message

POST/v1/channels/{channel_id}/messages/{message_id}/memes

Copies one attachment or embed asset from a message you can read into your collection and returns the new meme. You need VIEW_CHANNEL in a guild channel. Sends Favorite Meme Create.

JSON body

Field	Type	Description
name	string	The display name of the meme (1-100 characters)
attachment_id?1	?snowflake	The ID of an attachment in the message or one of its forwarded snapshots
embed_index?1	?integer	The zero-based index of an embed in the message or one of its snapshots
alt_text?2	?string	The accessibility description of the media (0-500 characters)
tags?	?array[string]	The search tags to store, each 1-30 characters

¹ Send at least one of these keys. If both are null, Fluxer takes the first attachment, then the first usable embed. From an embed, Fluxer uses its image, then its video, then its thumbnail

² Defaults to the selected attachment's own description when omitted, null or blank

Response

Status	Body	Condition
201	meme object	The meme was created
400	error response	INVALID_FORM_BODY3 when the body or selection fails validation
400	error response	MEDIA_METADATA_ERROR when the media cannot be read
400	error response	MAX_FAVORITE_MEMES when the collection is full
403	error response	MISSING_PERMISSIONS, MISSING_ACCESS or NSFW_CONTENT_AGE_RESTRICTED when you can't view the channel or aren't verified

³ The validation code is ATTACHMENT_ID_NOT_FOUND_IN_MESSAGE, EMBED_INDEX_OUT_OF_BOUNDS, NO_VALID_MEDIA_IN_MESSAGE, MEDIA_ALREADY_IN_FAVORITE_MEMES or MAX_FAVORITE_MEME_TAGS_EXCEEDED

The rate limit is 10 requests per minute, on the favorite_meme:create:message bucket.

Get meme

GET/v1/users/@me/memes/{meme_id}

Returns one of your memes.

Response

Status	Body	Condition
200	meme object	The meme was returned
404	error response	UNKNOWN_FAVORITE_MEME when you own no meme with that ID

The rate limit is 100 requests per 10 seconds, on the favorite_meme:get bucket.

Modify meme

PATCH/v1/users/@me/memes/{meme_id}

Changes the name, alt text or tags of one of your memes and returns it. Sends Favorite Meme Update.

JSON body

Field	Type	Description
name?	string	The replacement display name (1-100 characters)
alt_text?1	?string	The replacement accessibility description (0-500 characters)
tags?2	?array[string]	The replacement tags, each 1-30 characters

¹ Null clears it, and an omitted field stays unchanged

² Omit it or send null to keep the current tags

Sending tags replaces the whole list

An empty array removes every tag.

Response

Status	Body	Condition
200	meme object	The meme was updated
400	error response	INVALID_FORM_BODY, including MAX_FAVORITE_MEME_TAGS_EXCEEDED at tags
404	error response	UNKNOWN_FAVORITE_MEME when you own no meme with that ID

The rate limit is 30 requests per 10 seconds, on the favorite_meme:update bucket.

Delete meme

DELETE/v1/users/@me/memes/{meme_id}

Deletes one of your memes and returns 204, also when the meme doesn't exist. Fluxer sends Favorite Meme Delete only when it deleted one.

Deleting a meme also deletes Fluxer's copy of the file

You can't restore it.

Response

Status	Body	Condition
204	empty	The meme was deleted, or none existed

The rate limit is 30 requests per 10 seconds, on the favorite_meme:delete bucket.

Resolve GIF URLs

POST/v1/users/@me/favorite-gifs/resolve

Looks up GIF URLs and returns a resolved GIF entry for each one without saving anything. A URL Fluxer can't find still gets an entry, with an empty media map.

Request headers

Field	Type	Description
Accept-Language?	string	The preferred locale for the GIF provider lookup

JSON body

Field	Type	Description
urls	array[string]	The absolute GIF URLs to resolve (1-200)

Response body

Field	Type	Description
entries	array[resolved GIF entry object]	One entry for each submitted URL, in the same order

Response

Status	Body	Condition
200	response body	An entry was returned for each URL

The rate limit is 30 requests per minute, on the favorite_gif:resolve bucket.