v6 documentation is incomplete, want to contribute?

VRChat.community

API documentation, SDKs, and more
API Reference
Discord

Create World

Create a new world. This endpoint requires assetUrl to be a valid File object with .vrcw file extension, and imageUrl to be a valid File object with an image file extension.

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

POST
/worlds

Request Body

assetUrlstring
Length1 <= length
assetVersion?integer
Range0 <= value
authorId?string

A users unique ID, usually in the form of usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469. Legacy players can have old IDs in the form of 8JoV9XEdpo. The ID can never be changed.

authorName?string
Length1 <= length
capacity?integer
Range0 <= value <= 40
description?string
id?string

WorldID be "offline" on User profiles if you are not friends with that user.

imageUrlstring
Length1 <= length
namestring
Length1 <= length
platform?string

This can be standalonewindows or android, but can also pretty much be any random Unity verison such as 2019.2.4-801-Release or 2019.2.2-772-Release or even unknownplatform.

releaseStatus?string
Default"public"
Value in"public" | "private" | "hidden" | "all"
tags?array<Tag>
unityPackageUrl?string
Length1 <= length
unityVersion?string
Default"5.3.4p1"
Length1 <= length

Response Body

application/json

application/json

application/json

curl -X POST "https://api.vrchat.cloud/api/1/worlds" \
  -H "Content-Type: application/json" \
  -d '{
    "assetUrl": "string",
    "imageUrl": "string",
    "name": "string"
  }'
{
  "authorId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
  "authorName": "string",
  "capacity": 8,
  "recommendedCapacity": 4,
  "created_at": "2019-08-24T14:15:22Z",
  "defaultContentSettings": {
    "drones": true,
    "emoji": true,
    "pedestals": true,
    "prints": true,
    "stickers": true,
    "props": true
  },
  "description": "string",
  "favorites": 12024,
  "featured": false,
  "heat": 5,
  "id": "wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd",
  "imageUrl": "string",
  "instances": [
    [
      null,
      null
    ]
  ],
  "labsPublicationDate": "none",
  "name": "string",
  "namespace": "string",
  "occupants": 47,
  "organization": "vrchat",
  "popularity": 8,
  "previewYoutubeId": "string",
  "privateOccupants": 1,
  "publicOccupants": 46,
  "publicationDate": "none",
  "releaseStatus": "public",
  "storeId": "esto_713b247d-2b5d-41a0-bba3-50db28dc1498",
  "tags": [
    "string"
  ],
  "thumbnailImageUrl": "string",
  "unityPackages": [
    {
      "id": "unp_52b12c39-4163-457d-a4a9-630e7aff1bff",
      "assetUrl": "https://api.vrchat.cloud/api/1/file/file_cd0caa7b-69ba-4715-8dfe-7d667a9d2537/65/file",
      "assetUrlObject": {},
      "assetVersion": 4,
      "created_at": "2020-09-10T06:13:27.777Z",
      "impostorizerVersion": "0.17.0",
      "performanceRating": "Excellent",
      "platform": "standalonewindows",
      "pluginUrl": "",
      "pluginUrlObject": {},
      "unitySortNumber": 20180414000,
      "unityVersion": "2022.3.6f1",
      "worldSignature": "AHiPAWerwCpeYrxDthF5TU2SdUWEWnm43UAn8PKRXlS8k8tVRQ==",
      "impostorUrl": "string",
      "scanStatus": "string",
      "variant": "string"
    }
  ],
  "updated_at": "2019-08-24T14:15:22Z",
  "urlList": [
    "string"
  ],
  "version": 68,
  "visits": 9988675,
  "udonProducts": [
    "prod_c1644b5b-3ca4-45b4-97c6-a2a0de70d469"
  ]
}

{
  "error": {
    "message": "\\\"You can't create a world right now\\\"",
    "status_code": 400
  }
}

{
  "error": {
    "message": "\"Missing Credentials\"",
    "status_code": 401
  }
}