v6 documentation is incomplete, want to contribute?

VRChat.community

API documentation, SDKs, and more
API Reference
Discord

Show File

Shows general information about the "File" object. Each File can have several "Version"'s, and each Version can have multiple real files or "Data" blobs.

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

GET
/file/{fileId}

Authorization

auth<token>

Auth Token via Cookie

In: cookie

Path Parameters

fileIdstring

Must be a valid file ID.

Response Body

application/json

application/json

curl -X GET "https://api.vrchat.cloud/api/1/file/file_00000000-0000-0000-0000-000000000000"

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

{
  "error": {
    "message": "File 'file_ce35d830-e20a-4df0-a6d4-5aaef4508044' not found",
    "status_code": 404
  }
}