Skip to content

MediaUpload

An upload of a media file.

object
file
required

The file. Its declared type, if any, must match its content.

string format: binary
description

The alternative text. Text that is not UTF-8 or has U+0000 is a 422.

string
<= 1500 characters
purpose

What the file is for, which picks the sizes of its variants: an attachment of a post (within 640 × 360, 1920 × 1080, and 3840 × 2160 pixels of area), an avatar (cropped to squares of 96, 192, and 400 pixels around the focal point), a header (within 750 × 250, 1500 × 500, and 3000 × 1000), or a custom emoji (within 64, 128, and 256 pixels).

string
default: attachment
Allowed values: attachment avatar header emoji
thumbnail

The poster of a video or audio file: an image that it shows before it plays, which the client takes from the file. Its declared type is ignored; it must be an image within the image limits. It is ignored for an image.

string format: binary

Example generated

{
"file": "binary",
"description": "example",
"purpose": "attachment",
"thumbnail": "binary"
}

For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt

Analytics on this site