Skip to content

Clarify accepted image-data formats (emoji also accepts WebP/AVIF) #8538

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
spenhand wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Clarify accepted image-data formats (emoji also accepts WebP/AVIF) #8538

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,13 +377,13 @@ Sticker GIFs do not use the CDN base url, and can be accessed at `https://media.

## Image Data

Image data is a [Data URI scheme](https://en.wikipedia.org/wiki/Data_URI_scheme) that supports JPG, GIF, and PNG formats. An example Data URI format is:
Image data is a [Data URI scheme](https://en.wikipedia.org/wiki/Data_URI_scheme) carrying a base64-encoded image. Most endpoints accept JPG, GIF, and PNG; some accept additional formats — for example, [emoji](/docs/resources/emoji#emoji-object-emoji-formats) also accept WebP and AVIF. Refer to the specific resource for the formats it supports. An example Data URI format is:

```
data:image/jpeg;base64,BASE64_ENCODED_JPEG_IMAGE_DATA
```

Ensure you use the proper content type (`image/jpeg`, `image/png`, `image/gif`) that matches the image data being provided.
The accepted format is determined from the encoded image data itself, so you should set a content type (`image/jpeg`, `image/png`, `image/gif`, etc.) that matches the image being provided.

### Signed Attachment CDN URLs

Expand Down