View Source VRChat.Worlds (vrchat v1.11.1)

API calls for all endpoints tagged Worlds.

Link to this section Summary

Functions

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.

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.

List Active Worlds Search and list currently Active worlds by query filters.

List Favorited Worlds Search and list favorited worlds by query filters.

List Recent Worlds Search and list recently visited worlds by query filters.

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

Get World Instance Returns a worlds instance.

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.

Get World Publish Status Returns a worlds publish status.

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

Search All Worlds Search and list any worlds by query filters.

Unpublish World Unpublish a world.

Update World Update information about a specific World.

Link to this section Functions

Link to this function

create_world(connection, opts \\ [])

View Source
@spec create_world(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, VRChat.Model.World.t()}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

  • connection (VRChat.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :body (CreateWorldRequest):

returns

Returns

  • {:ok, VRChat.Model.World.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

delete_world(connection, world_id, opts \\ [])

View Source
@spec delete_world(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:ok, VRChat.Model.Error.t()} | {:error, Tesla.Env.t()}

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

Parameters

  • connection (VRChat.Connection): Connection to server
  • world_id (String.t): Must be a valid world ID.
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_active_worlds(connection, opts \\ [])

View Source
@spec get_active_worlds(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, [VRChat.Model.LimitedWorld.t()]}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

List Active Worlds Search and list currently Active worlds by query filters.

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :featured (boolean()): Filters on featured results.
    • :sort (SortOption): The sort order of the results.
    • :n (integer()): The number of objects to return.
    • :order (OrderOption): Result ordering
    • :offset (integer()): A zero-based offset from the default object sorting from where search results start.
    • :search (String.t): Filters by world name.
    • :tag (String.t): Tags to include (comma-separated). Any of the tags needs to be present.
    • :notag (String.t): Tags to exclude (comma-separated).
    • :releaseStatus (ReleaseStatus): Filter by ReleaseStatus.
    • :maxUnityVersion (String.t): The maximum Unity version supported by the asset.
    • :minUnityVersion (String.t): The minimum Unity version supported by the asset.
    • :platform (String.t): The platform the asset supports.

returns

Returns

  • {:ok, [%LimitedWorld{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_favorited_worlds(connection, opts \\ [])

View Source
@spec get_favorited_worlds(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, [VRChat.Model.LimitedWorld.t()]}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

List Favorited Worlds Search and list favorited worlds by query filters.

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :featured (boolean()): Filters on featured results.
    • :sort (SortOption): The sort order of the results.
    • :n (integer()): The number of objects to return.
    • :order (OrderOption): Result ordering
    • :offset (integer()): A zero-based offset from the default object sorting from where search results start.
    • :search (String.t): Filters by world name.
    • :tag (String.t): Tags to include (comma-separated). Any of the tags needs to be present.
    • :notag (String.t): Tags to exclude (comma-separated).
    • :releaseStatus (ReleaseStatus): Filter by ReleaseStatus.
    • :maxUnityVersion (String.t): The maximum Unity version supported by the asset.
    • :minUnityVersion (String.t): The minimum Unity version supported by the asset.
    • :platform (String.t): The platform the asset supports.
    • :userId (String.t): Target user to see information on, admin-only.

returns

Returns

  • {:ok, [%LimitedWorld{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_recent_worlds(connection, opts \\ [])

View Source
@spec get_recent_worlds(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, [VRChat.Model.LimitedWorld.t()]}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

List Recent Worlds Search and list recently visited worlds by query filters.

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :featured (boolean()): Filters on featured results.
    • :sort (SortOption): The sort order of the results.
    • :n (integer()): The number of objects to return.
    • :order (OrderOption): Result ordering
    • :offset (integer()): A zero-based offset from the default object sorting from where search results start.
    • :search (String.t): Filters by world name.
    • :tag (String.t): Tags to include (comma-separated). Any of the tags needs to be present.
    • :notag (String.t): Tags to exclude (comma-separated).
    • :releaseStatus (ReleaseStatus): Filter by ReleaseStatus.
    • :maxUnityVersion (String.t): The maximum Unity version supported by the asset.
    • :minUnityVersion (String.t): The minimum Unity version supported by the asset.
    • :platform (String.t): The platform the asset supports.
    • :userId (String.t): Target user to see information on, admin-only.

returns

Returns

  • {:ok, [%LimitedWorld{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_world(connection, world_id, opts \\ [])

View Source
@spec get_world(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, VRChat.Model.World.t()}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

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

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • world_id (String.t): Must be a valid world ID.
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, VRChat.Model.World.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_world_instance(connection, world_id, instance_id, opts \\ [])

View Source
@spec get_world_instance(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, VRChat.Model.Instance.t()}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

Get World Instance Returns a worlds instance.

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • world_id (String.t): Must be a valid world ID.
  • instance_id (String.t): Must be a valid instance ID.
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, VRChat.Model.Instance.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_world_metadata(connection, world_id, opts \\ [])

View Source
@spec get_world_metadata(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, VRChat.Model.WorldMetadata.t()}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

  • connection (VRChat.Connection): Connection to server
  • world_id (String.t): Must be a valid world ID.
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, VRChat.Model.WorldMetadata.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_world_publish_status(connection, world_id, opts \\ [])

View Source
@spec get_world_publish_status(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, VRChat.Model.WorldPublishStatus.t()}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

Get World Publish Status Returns a worlds publish status.

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • world_id (String.t): Must be a valid world ID.
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, VRChat.Model.WorldPublishStatus.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

publish_world(connection, world_id, opts \\ [])

View Source
@spec publish_world(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:ok, VRChat.Model.Error.t()} | {:error, Tesla.Env.t()}

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

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • world_id (String.t): Must be a valid world ID.
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

search_worlds(connection, opts \\ [])

View Source
@spec search_worlds(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, [VRChat.Model.LimitedWorld.t()]}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

Search All Worlds Search and list any worlds by query filters.

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :featured (boolean()): Filters on featured results.
    • :sort (SortOption): The sort order of the results.
    • :user (String.t): Set to me for searching own worlds.
    • :userId (String.t): Filter by UserID.
    • :n (integer()): The number of objects to return.
    • :order (OrderOption): Result ordering
    • :offset (integer()): A zero-based offset from the default object sorting from where search results start.
    • :search (String.t): Filters by world name.
    • :tag (String.t): Tags to include (comma-separated). Any of the tags needs to be present.
    • :notag (String.t): Tags to exclude (comma-separated).
    • :releaseStatus (ReleaseStatus): Filter by ReleaseStatus.
    • :maxUnityVersion (String.t): The maximum Unity version supported by the asset.
    • :minUnityVersion (String.t): The minimum Unity version supported by the asset.
    • :platform (String.t): The platform the asset supports.

returns

Returns

  • {:ok, [%LimitedWorld{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

unpublish_world(connection, world_id, opts \\ [])

View Source
@spec unpublish_world(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:ok, VRChat.Model.Error.t()} | {:error, Tesla.Env.t()}

Unpublish World Unpublish a world.

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • world_id (String.t): Must be a valid world ID.
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

update_world(connection, world_id, opts \\ [])

View Source
@spec update_world(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, VRChat.Model.World.t()}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

Update World Update information about a specific World.

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • world_id (String.t): Must be a valid world ID.
  • opts (keyword): Optional parameters
    • :body (UpdateWorldRequest):

returns

Returns

  • {:ok, VRChat.Model.World.t} on success
  • {:error, Tesla.Env.t} on failure