VRChatBackendDocs/Apis/WorldsApi.md

WorldsApi

All URIs are relative to https://api.vrchat.cloud/api/1

Method	HTTP request	Description
checkUserPersistenceExists	GET /users/{userId}/{worldId}/persist/exists	Check User Persistence Exists
createWorld	POST /worlds	Create World
deleteAllUserPersistenceData	DELETE /users/{userId}/persist	Delete All User Persistence Data
deleteUserPersistence	DELETE /users/{userId}/{worldId}/persist	Delete User Persistence
deleteWorld	DELETE /worlds/{worldId}	Delete World
getActiveWorlds	GET /worlds/active	List Active Worlds
getFavoritedWorlds	GET /worlds/favorites	List Favorited Worlds
getRecentWorlds	GET /worlds/recent	List Recent Worlds
getWorld	GET /worlds/{worldId}	Get World by ID
getWorldInstance	GET /worlds/{worldId}/{instanceId}	Get World Instance
getWorldMetadata	GET /worlds/{worldId}/metadata	Get World Metadata
getWorldPublishStatus	GET /worlds/{worldId}/publish	Get World Publish Status
publishWorld	PUT /worlds/{worldId}/publish	Publish World
searchWorlds	GET /worlds	Search All Worlds
unpublishWorld	DELETE /worlds/{worldId}/publish	Unpublish World
updateWorld	PUT /worlds/{worldId}	Update World

checkUserPersistenceExists

checkUserPersistenceExists(userId, worldId)

Check User Persistence Exists

Checks whether the user has persistence data for a given world

Parameters

Name	Type	Description	Notes
userId	String	Must be a valid user ID.	[default to null]
worldId	String	Must be a valid world ID.	[default to null]

Return type

null (empty response body)

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

createWorld

World createWorld(CreateWorldRequest)

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.

Parameters

Name	Type	Description	Notes
CreateWorldRequest	CreateWorldRequest		[optional]

Return type

World

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

deleteAllUserPersistenceData

deleteAllUserPersistenceData(userId)

Delete All User Persistence Data

Deletes all of the user's persistence data for every world.

Parameters

Name	Type	Description	Notes
userId	String	Must be a valid user ID.	[default to null]

Return type

null (empty response body)

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

deleteUserPersistence

deleteUserPersistence(userId, worldId)

Delete User Persistence

Deletes the user's persistence data for a given world

Parameters

Name	Type	Description	Notes
userId	String	Must be a valid user ID.	[default to null]
worldId	String	Must be a valid world ID.	[default to null]

Return type

null (empty response body)

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

deleteWorld

deleteWorld(worldId)

Delete World

Delete a world. Notice a world is never fully \"deleted\", only its ReleaseStatus is set to \"hidden\" and the linked Files are deleted. The WorldID is permanently reserved.

Parameters

Name	Type	Description	Notes
worldId	String	Must be a valid world ID.	[default to null]

Return type

null (empty response body)

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getActiveWorlds

List getActiveWorlds(featured, sort, n, order, offset, search, tag, notag, releaseStatus, maxUnityVersion, minUnityVersion, platform, noplatform)

List Active Worlds

Search and list currently Active worlds by query filters.

Parameters

Name	Type	Description	Notes
featured	Boolean	Filters on featured results.	[optional] [default to null]
sort	String	The sort order of the results.	[optional] [default to popularity] [enum: _created_at, _updated_at, created, favorites, heat, labsPublicationDate, magic, name, order, popularity, publicationDate, random, relevance, reportCount, reportScore, shuffle, trust, updated]
n	Integer	The number of objects to return.	[optional] [default to 60]
order	String	Result ordering	[optional] [default to descending] [enum: ascending, descending]
offset	Integer	A zero-based offset from the default object sorting from where search results start.	[optional] [default to null]
search	String	Filters by world name.	[optional] [default to null]
tag	String	Tags to include (comma-separated). Any of the tags needs to be present.	[optional] [default to null]
notag	String	Tags to exclude (comma-separated).	[optional] [default to null]
releaseStatus	String	Filter by ReleaseStatus.	[optional] [default to public] [enum: all, hidden, private, public]
maxUnityVersion	String	The maximum Unity version supported by the asset.	[optional] [default to null]
minUnityVersion	String	The minimum Unity version supported by the asset.	[optional] [default to null]
platform	String	The platform the asset supports.	[optional] [default to null]
noplatform	String	The platform the asset does not support.	[optional] [default to null]

Return type

List

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getFavoritedWorlds

List getFavoritedWorlds(featured, sort, n, order, offset, search, tag, notag, releaseStatus, maxUnityVersion, minUnityVersion, platform, userId)

List Favorited Worlds

Search and list favorited worlds by query filters.

Parameters

Name	Type	Description	Notes
featured	Boolean	Filters on featured results.	[optional] [default to null]
sort	String	The sort order of the results.	[optional] [default to popularity] [enum: _created_at, _updated_at, created, favorites, heat, labsPublicationDate, magic, name, order, popularity, publicationDate, random, relevance, reportCount, reportScore, shuffle, trust, updated]
n	Integer	The number of objects to return.	[optional] [default to 60]
order	String	Result ordering	[optional] [default to descending] [enum: ascending, descending]
offset	Integer	A zero-based offset from the default object sorting from where search results start.	[optional] [default to null]
search	String	Filters by world name.	[optional] [default to null]
tag	String	Tags to include (comma-separated). Any of the tags needs to be present.	[optional] [default to null]
notag	String	Tags to exclude (comma-separated).	[optional] [default to null]
releaseStatus	String	Filter by ReleaseStatus.	[optional] [default to public] [enum: all, hidden, private, public]
maxUnityVersion	String	The maximum Unity version supported by the asset.	[optional] [default to null]
minUnityVersion	String	The minimum Unity version supported by the asset.	[optional] [default to null]
platform	String	The platform the asset supports.	[optional] [default to null]
userId	String	Target user to see information on, admin-only.	[optional] [default to null]

Return type

List

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getRecentWorlds

List getRecentWorlds(featured, sort, n, order, offset, search, tag, notag, releaseStatus, maxUnityVersion, minUnityVersion, platform, userId)

List Recent Worlds

Search and list recently visited worlds by query filters.

Parameters

Name	Type	Description	Notes
featured	Boolean	Filters on featured results.	[optional] [default to null]
sort	String	The sort order of the results.	[optional] [default to popularity] [enum: _created_at, _updated_at, created, favorites, heat, labsPublicationDate, magic, name, order, popularity, publicationDate, random, relevance, reportCount, reportScore, shuffle, trust, updated]
n	Integer	The number of objects to return.	[optional] [default to 60]
order	String	Result ordering	[optional] [default to descending] [enum: ascending, descending]
offset	Integer	A zero-based offset from the default object sorting from where search results start.	[optional] [default to null]
search	String	Filters by world name.	[optional] [default to null]
tag	String	Tags to include (comma-separated). Any of the tags needs to be present.	[optional] [default to null]
notag	String	Tags to exclude (comma-separated).	[optional] [default to null]
releaseStatus	String	Filter by ReleaseStatus.	[optional] [default to public] [enum: all, hidden, private, public]
maxUnityVersion	String	The maximum Unity version supported by the asset.	[optional] [default to null]
minUnityVersion	String	The minimum Unity version supported by the asset.	[optional] [default to null]
platform	String	The platform the asset supports.	[optional] [default to null]
userId	String	Target user to see information on, admin-only.	[optional] [default to null]

Return type

List

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getWorld

World getWorld(worldId)

Get World by ID

Get information about a specific World. Works unauthenticated but when so will always return `0` for certain fields.

Parameters

Name	Type	Description	Notes
worldId	String	Must be a valid world ID.	[default to null]

Return type

World

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getWorldInstance

Instance getWorldInstance(worldId, instanceId)

Get World Instance

Returns a worlds instance.

Parameters

Name	Type	Description	Notes
worldId	String	Must be a valid world ID.	[default to null]
instanceId	String	Must be a valid instance ID.	[default to null]

Return type

Instance

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getWorldMetadata

WorldMetadata getWorldMetadata(worldId)

Get World Metadata

Return a worlds custom metadata. This is currently believed to be unused. Metadata can be set with `updateWorld` and can be any arbitrary object.

Parameters

Name	Type	Description	Notes
worldId	String	Must be a valid world ID.	[default to null]

Return type

WorldMetadata

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getWorldPublishStatus

WorldPublishStatus getWorldPublishStatus(worldId)

Get World Publish Status

Returns a worlds publish status.

Parameters

Name	Type	Description	Notes
worldId	String	Must be a valid world ID.	[default to null]

Return type

WorldPublishStatus

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

publishWorld

publishWorld(worldId)

Publish World

Publish a world. You can only publish one world per week.

Parameters

Name	Type	Description	Notes
worldId	String	Must be a valid world ID.	[default to null]

Return type

null (empty response body)

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

searchWorlds

List searchWorlds(featured, sort, user, userId, n, order, offset, search, tag, notag, releaseStatus, maxUnityVersion, minUnityVersion, platform, noplatform, fuzzy, avatarSpecific)

Search All Worlds

Search and list any worlds by query filters.

Parameters

Name	Type	Description	Notes
featured	Boolean	Filters on featured results.	[optional] [default to null]
sort	String	The sort order of the results.	[optional] [default to popularity] [enum: _created_at, _updated_at, created, favorites, heat, labsPublicationDate, magic, name, order, popularity, publicationDate, random, relevance, reportCount, reportScore, shuffle, trust, updated]
user	String	Set to `me` for searching own worlds.	[optional] [default to null] [enum: me]
userId	String	Filter by UserID.	[optional] [default to null]
n	Integer	The number of objects to return.	[optional] [default to 60]
order	String	Result ordering	[optional] [default to descending] [enum: ascending, descending]
offset	Integer	A zero-based offset from the default object sorting from where search results start.	[optional] [default to null]
search	String	Filters by world name.	[optional] [default to null]
tag	String	Tags to include (comma-separated). Any of the tags needs to be present.	[optional] [default to null]
notag	String	Tags to exclude (comma-separated).	[optional] [default to null]
releaseStatus	String	Filter by ReleaseStatus.	[optional] [default to public] [enum: all, hidden, private, public]
maxUnityVersion	String	The maximum Unity version supported by the asset.	[optional] [default to null]
minUnityVersion	String	The minimum Unity version supported by the asset.	[optional] [default to null]
platform	String	The platform the asset supports.	[optional] [default to null]
noplatform	String	The platform the asset does not support.	[optional] [default to null]
fuzzy	Boolean		[optional] [default to null]
avatarSpecific	Boolean	Only search for avatar worlds.	[optional] [default to null]

Return type

List

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

unpublishWorld

unpublishWorld(worldId)

Unpublish World

Unpublish a world.

Parameters

Name	Type	Description	Notes
worldId	String	Must be a valid world ID.	[default to null]

Return type

null (empty response body)

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

updateWorld

World updateWorld(worldId, UpdateWorldRequest)

Update World

Update information about a specific World.

Parameters

Name	Type	Description	Notes
worldId	String	Must be a valid world ID.	[default to null]
UpdateWorldRequest	UpdateWorldRequest		[optional]

Return type

World

Authorization

authCookie

HTTP request headers

• Content-Type: application/json
• Accept: application/json