v6 documentation is incomplete, want to contribute?

VRChat.community

API documentation, SDKs, and more
API Reference
Discord

Start FileData Upload

Starts an upload of a specific FilePart. This endpoint will return an AWS URL which you can PUT data to. You need to call this and receive a new AWS API URL for each partNumber. Please see AWS's REST documentation on "PUT Object to S3" on how to upload. Once all parts has been uploaded, proceed to /finish endpoint.

Note: nextPartNumber seems like it is always ignored. Despite it returning 0, first partNumber is always 1.

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

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

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"

Query Parameters

partNumber?integerDeprecated

The part number to start uploading. If not provided, the first part will be started.

Range0 <= value

Response Body

application/json

application/json

curl -X PUT "https://api.vrchat.cloud/api/1/file/file_00000000-0000-0000-0000-000000000000/1/file/start?partNumber=1"

{
  "url": "https://s3.amazonaws.com/files.vrchat.cloud/Avatar-MyAvatar-Un.file_00000000-0000-0000-0000-000000000000.1.unitypackage?AWSAccessKeyId=XXXXXXXXXXXXXXXXXXXX&Expires=1626028518&Signature=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&partNumber=1&uploadId=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxx.xxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx..xxxxxxxxxxxxxxxxxxxxxxx"
}

{
  "error": {
    "message": "Cannot upload against a complete version entry․ Create a new version of this file before uploading․",
    "status_code": 400
  }
}