Buttondown logo

Creating an image

Supported formats

Buttondown accepts PNG, JPG, and GIF images. SVG files are rejected by default because most email clients don't render them reliably — your subscribers would see a broken image instead.

If you upload an SVG, the API will return a 400 with:

{
  "detail": "SVG files are not supported. Please upload a PNG, JPG, or GIF."
}

Bypassing SVG validation

If you know what you're doing (e.g. your SVGs are only used on the web archive, not in emails), you can bypass this restriction by providing a X-Buttondown-Live-Dangerously header with a value of true:

curl -X POST "https://api.buttondown.com/v1/images" \
  -H "Authorization: Token YOUR_API_KEY" \
  -H "X-Buttondown-Live-Dangerously: true" \
  -F "image=@logo.svg"

Sample requests

These sample requests are autogenerated by the OpenAPI spec.

import requests

url = "https://api.buttondown.com/v1/images"
headers = {
  "Authorization": "Token $BUTTONDOWN_API_KEY"
}
files = {
    "image": open("path/to/your/image.jpg", "rb")
}

response = requests.request("POST", url, headers=headers, files=files)
print(response.text)

Sample responses

The IDs and values referenced in these responses are fake; please only rely on these responses for overall structure.

{
    "creation_date": "2019-08-24T14:15:22Z",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "image": "https://placecats.com/408/287"
}

Body parameters

All parameters are optional unless explicitly specified.