v6 documentation is incomplete, want to contribute?

VRChat.community

API documentation, SDKs, and more
API Reference
Discord

Finish FileData Upload

Finish an upload of a FileData. This will mark it as "complete". After uploading the file for Avatars and Worlds you then have to upload a signature file.

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

PUT
/file/{fileId}/{versionId}/{fileType}/finish

Authorization

auth<token>

Auth Token via Cookie

In: cookie

Path Parameters

fileIdstring

Must be a valid file ID.

versionIdinteger

Version ID of the asset.

Range1 <= value
fileTypestring

Type of file.

Value in"file" | "signature" | "delta"

Request Body

Please see documentation on ETag's: https://teppen.io/2018/06/23/aws_s3_etags/

ETag's should NOT be present when uploading a signature.

etags?array<string>

Array of ETags uploaded.

Items1 <= items
nextPartNumberstringDeprecated

Always a zero in string form, despite how many parts uploaded.

Default"0"
Length1 <= length <= 1
maxPartsstringDeprecated

Always a zero in string form, despite how many parts uploaded.

Default"0"
Length1 <= length <= 1

Response Body

application/json

curl -X PUT "https://api.vrchat.cloud/api/1/file/file_00000000-0000-0000-0000-000000000000/1/file/finish" \
  -H "Content-Type: application/json" \
  -d '{
    "etags": [
      "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy"
    ],
    "nextPartNumber": "0",
    "maxParts": "0"
  }'

{
  "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": ""
      }
    }
  ]
}