# WorldsApi

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

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


<a name="checkUserPersistenceExists"></a>
# **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](../README.md#authCookie)

### HTTP request headers

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

<a name="createWorld"></a>
# **createWorld**
> World createWorld(CreateWorldRequest)

Create World

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

### Parameters

|Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **CreateWorldRequest** | [**CreateWorldRequest**](../Models/CreateWorldRequest.md)|  | [optional] |

### Return type

[**World**](../Models/World.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="deleteAllUserPersistenceData"></a>
# **deleteAllUserPersistenceData**
> deleteAllUserPersistenceData(userId)

Delete All User Persistence Data

    Deletes all of the user&#39;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](../README.md#authCookie)

### HTTP request headers

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

<a name="deleteUserPersistence"></a>
# **deleteUserPersistence**
> deleteUserPersistence(userId, worldId)

Delete User Persistence

    Deletes the user&#39;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](../README.md#authCookie)

### HTTP request headers

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

<a name="deleteWorld"></a>
# **deleteWorld**
> deleteWorld(worldId)

Delete World

    Delete a world. Notice a world is never fully \&quot;deleted\&quot;, only its ReleaseStatus is set to \&quot;hidden\&quot; 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](../README.md#authCookie)

### HTTP request headers

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

<a name="getActiveWorlds"></a>
# **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**](../Models/LimitedWorld.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

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

<a name="getFavoritedWorlds"></a>
# **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**](../Models/FavoritedWorld.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

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

<a name="getRecentWorlds"></a>
# **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**](../Models/LimitedWorld.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

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

<a name="getWorld"></a>
# **getWorld**
> World getWorld(worldId)

Get World by ID

    Get information about a specific World. Works unauthenticated but when so will always return &#x60;0&#x60; for certain fields.

### Parameters

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

### Return type

[**World**](../Models/World.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="getWorldInstance"></a>
# **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**](../Models/Instance.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

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

<a name="getWorldMetadata"></a>
# **getWorldMetadata**
> WorldMetadata getWorldMetadata(worldId)

Get World Metadata

    Return a worlds custom metadata. This is currently believed to be unused. Metadata can be set with &#x60;updateWorld&#x60; 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**](../Models/WorldMetadata.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="getWorldPublishStatus"></a>
# **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**](../Models/WorldPublishStatus.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

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

<a name="publishWorld"></a>
# **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](../README.md#authCookie)

### HTTP request headers

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

<a name="searchWorlds"></a>
# **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 &#x60;me&#x60; 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**](../Models/LimitedWorld.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

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

<a name="unpublishWorld"></a>
# **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](../README.md#authCookie)

### HTTP request headers

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

<a name="updateWorld"></a>
# **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**](../Models/UpdateWorldRequest.md)|  | [optional] |

### Return type

[**World**](../Models/World.md)

### Authorization

[authCookie](../README.md#authCookie)

### HTTP request headers

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