Uploads

Creates an upload

POST

https://discourse.example.com/uploads.json

Creates an upload

curl -X POST 'https://discourse.example.com/uploads.json' \
  --form-string 'upload_type=avatar' \
  --form-string 'user_id=0' \
  --form-string 'synchronous=true'

const form = new FormData();
form.append('upload_type', 'avatar');
form.append('user_id', '0');
form.append('synchronous', 'true');
const response = await fetch('https://discourse.example.com/uploads.json', {
  method: 'POST',
  headers: {},
  body: form,
});
console.log(await response.text());

import requests
from contextlib import ExitStack

with ExitStack() as stack:
    files = [
        ('upload_type', (None, 'avatar')),
        ('user_id', (None, '0')),
        ('synchronous', (None, 'true')),
    ]
    response = requests.request('POST', 'https://discourse.example.com/uploads.json', headers={}, files=files)
    print(response.text)

Request Body

{
  "upload_type": "avatar",
  "user_id": 0,
  "synchronous": true,
  "file": "<binary>"
}

200

{
  "id": 0,
  "url": "string",
  "original_filename": "string",
  "filesize": 0,
  "width": 0,
  "height": 0,
  "thumbnail_width": 0,
  "thumbnail_height": 0,
  "extension": "string",
  "short_url": "string",
  "short_path": "string",
  "retain_hours": "string",
  "human_filesize": "string",
  "dominant_color": "string",
  "thumbnail": {
    "id": 0,
    "upload_id": 0,
    "url": "string",
    "extension": "string",
    "width": 0,
    "height": 0,
    "filesize": 0
  },
  "optimized_video": {
    "id": 0,
    "upload_id": 0,
    "url": "string",
    "extension": "string",
    "filesize": 0,
    "sha1": "string",
    "original_filename": "string"
  }
}

Body

multipart/form-data

upload_typestringavatarprofile_backgroundcard_backgroundcustom_emojicomposerrequired

user_idinteger

required if uploading an avatar

synchronousboolean

Use this flag to return an id and url

filestring<binary>

Response

200OKany

file uploaded

Response fields application/json

idintegerrequired

urlstringrequired

original_filenamestringrequired

filesizeintegerrequired

widthintegerrequired

heightintegerrequired

thumbnail_widthintegerrequired

thumbnail_heightintegerrequired

extensionstringrequired

short_urlstringrequired

short_pathstringrequired

retain_hoursstring | nullrequired

human_filesizestringrequired

dominant_colorstring | null

thumbnailobject | null

Show child attributes

idinteger

upload_idinteger

urlstring

extensionstring

widthinteger

heightinteger

filesizeinteger

optimized_videoobject | null

Show child attributes

idinteger

upload_idinteger

urlstring

extensionstring

filesizeinteger

sha1string

original_filenamestring

Docs by Sourcey