View Source VRChat.System (vrchat v1.11.1)

API calls for all endpoints tagged System.

Link to this section Summary

Functions

Fetch API Config API config contains configuration that the clients needs to work properly. Currently the most important value here is clientApiKey which is used for all other API endpoints.

Download CSS Fetches the CSS code to the frontend React website.

Current Online Users Returns the current number of online users. NOTE: The response type is not a JSON object, but a simple JSON integer.

Check API Health Gets the overall health status, the server name, and the current build version tag of the API. DEPRECATED: VRChat has suddenly restricted this endpoint for unknown reasons, and now always return 401 Unauthorized.

Show Information Notices IPS (Info Push System) is a system for VRChat to push out dynamic information to the client. This is primarily used by the Quick-Menu info banners, but can also be used to e.g. alert you to update your game to the latest version. include is used to query what Information Pushes should be included in the response. If include is missing or empty, then no notices will normally be returned. This is an "any of" search. require is used to limit what Information Pushes should be included in the response. This is usually used in combination with include, and is an "all of" search.

Download JavaScript Fetches the JavaScript code to the frontend React website.

Current System Time Returns the current time of the API server. NOTE: The response type is not a JSON object, but a simple JSON string.

Link to this section Functions

Link to this function

get_config(connection, opts \\ [])

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

Fetch API Config API config contains configuration that the clients needs to work properly. Currently the most important value here is clientApiKey which is used for all other API endpoints.

parameters

Parameters

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

returns

Returns

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

get_css(connection, opts \\ [])

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

Download CSS Fetches the CSS code to the frontend React website.

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :variant (String.t): Specifies which variant of the site. Public is the end-user site, while internal is the staff-only site with special pages for moderation and management.
    • :branch (String.t): Specifies which git branch the site should load frontend source code from.

returns

Returns

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

get_current_online_users(connection, opts \\ [])

View Source
@spec get_current_online_users(
  Tesla.Env.client(),
  keyword()
) :: {:ok, Integer.t()} | {:error, Tesla.Env.t()}

Current Online Users Returns the current number of online users. NOTE: The response type is not a JSON object, but a simple JSON integer.

parameters

Parameters

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

returns

Returns

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

get_health(connection, opts \\ [])

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

Check API Health Gets the overall health status, the server name, and the current build version tag of the API. DEPRECATED: VRChat has suddenly restricted this endpoint for unknown reasons, and now always return 401 Unauthorized.

parameters

Parameters

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

returns

Returns

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

get_info_push(connection, opts \\ [])

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

Show Information Notices IPS (Info Push System) is a system for VRChat to push out dynamic information to the client. This is primarily used by the Quick-Menu info banners, but can also be used to e.g. alert you to update your game to the latest version. include is used to query what Information Pushes should be included in the response. If include is missing or empty, then no notices will normally be returned. This is an "any of" search. require is used to limit what Information Pushes should be included in the response. This is usually used in combination with include, and is an "all of" search.

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :require (String.t): Tags to include (comma-separated). All of the tags needs to be present.
    • :include (String.t): Tags to include (comma-separated). Any of the tags needs to be present.

returns

Returns

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

get_java_script(connection, opts \\ [])

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

Download JavaScript Fetches the JavaScript code to the frontend React website.

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :variant (String.t): Specifies which variant of the site. Public is the end-user site, while internal is the staff-only site with special pages for moderation and management.
    • :branch (String.t): Specifies which git branch the site should load frontend source code from.

returns

Returns

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

get_system_time(connection, opts \\ [])

View Source
@spec get_system_time(
  Tesla.Env.client(),
  keyword()
) :: {:ok, DateTime.t()} | {:error, Tesla.Env.t()}

Current System Time Returns the current time of the API server. NOTE: The response type is not a JSON object, but a simple JSON string.

parameters

Parameters

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

returns

Returns

  • {:ok, DateTime.t} on success
  • {:error, Tesla.Env.t} on failure