v6 documentation is incomplete, want to contribute?

Upload gallery image, icon, emoji or sticker

Upload an image, which can be an icon, gallery image, sticker or emoji

Requests made through this page are proxied through an intermediary server due to Cross-Origin Resource Sharing restrictions.

POST
/file/image
auth<token>

Auth Token via Cookie

In: cookie

filestring

The binary blob of the png file.

tagstring

Needs to be either icon, gallery, sticker, emoji, or emojianimated

frames?integer

Required for emojianimated. Total number of frames to be animated (2-64)

framesOverTime?integer

Required for emojianimated. Animation frames per second (1-64)

animationStyle?string

Animation style for sticker, required for emoji.

maskTag?string

Mask of the sticker, optional for emoji.

Response Body

application/json

curl -X POST "https://api.vrchat.cloud/api/1/file/image" \
  -F file="string" \
  -F tag="string"

{
  "id": "file_00000000-0000-0000-0000-000000000000",
  "name": "Avatar - Test Avatar - Unity package - 2017․4․28f1_3_standalonewindows_Release",
  "ownerId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
  "mimeType": "application/gzip",
  "extension": ".unitypackage",
  "tags": [],
  "versions": [
    {
      "version": 0,
      "status": "complete",
      "created_at": "2019-08-15T11:04:37.910Z"
    },
    {
      "version": 1,
      "status": "complete",
      "created_at": "2019-08-15T11:04:49.702Z",
      "file": {
        "fileName": "Avatar-Test-Avatar-Unity.file_00000000-0000-0000-0000-000000000000.1.unitypackage",
        "url": "https://s3.us-east-1.amazonaws.com/files.vrchat.cloud/Avatar-Test-Avatar-Unity.file_00000000-0000-0000-0000-000000000000.1.unitypackage",
        "md5": "xxxxxxxxxxxxxxxxxxx==",
        "sizeInBytes": 303055180,
        "status": "complete",
        "category": "multipart",
        "uploadId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
      },
      "delta": {
        "fileName": "Avatar-Test-Avatar-Unity.file_00000000-0000-0000-0000-000000000000.1.unitypackage.delta",
        "url": "https://s3.us-east-1.amazonaws.com/files.vrchat.cloud/Avatar-Test-Avatar-Unity.file_00000000-0000-0000-0000-000000000000.1.unitypackage.delta",
        "md5": "",
        "sizeInBytes": 0,
        "status": "none",
        "category": "queued",
        "uploadId": ""
      },
      "signature": {
        "fileName": "Avatar-Test-Avatar-Unity.file_00000000-0000-0000-0000-000000000000.1.unitypackage.signature",
        "url": "https://s3.us-east-1.amazonaws.com/files.vrchat.cloud/Avatar-Test-Avatar-Unity.file_00000000-0000-0000-0000-000000000000.1.unitypackage.signature",
        "md5": "xxxxxxxxxxxxxxxx==",
        "sizeInBytes": 532748,
        "status": "complete",
        "category": "simple",
        "uploadId": ""
      }
    }
  ]
}