VRChatBackendDocs/Models/APIConfig.md

APIConfig

Properties

Name	Type	Description	Notes
CampaignStatus	String	The current platform-wide event taking place	[default to null]
DisableBackgroundPreloads	Boolean	Toggles if certain assets are preloaded in the background	[default to true]
LocationGiftingNonSubPrioEnabled	Boolean	Toggles whether users without a current VRC+ subscription are priority recipients for gift drops	[default to true]
VoiceEnableDegradation	Boolean	Unknown, probably voice optimization testing	[default to false]
VoiceEnableReceiverLimiting	Boolean	Unknown, probably voice optimization testing	[default to true]
accessLogsUrls	APIConfig_accessLogsUrls		[default to null]
address	String	VRChat's office address	[default to null]
ageVerificationInviteVisible	Boolean		[default to null]
ageVerificationP	Boolean		[default to null]
ageVerificationStatusVisible	Boolean		[default to null]
analysisMaxRetries	Integer	Max retries for avatar analysis requests	[default to null]
analysisRetryInterval	Integer	Interval between retries for avatar analysis requests	[default to null]
analyticsSegment_NewUI_PctOfUsers	Integer	Unknown	[default to null]
analyticsSegment_NewUI_Salt	String	Unknown	[default to null]
announcements	Set	Public Announcements	[default to null]
audioConfig	APIConfigAudioConfig		[optional] [default to null]
availableLanguageCodes	List	List of supported Languages	[default to null]
availableLanguages	List	List of supported Languages	[default to null]
avatarPerfLimiter	APIConfig_avatarPerfLimiter		[default to null]
chatboxLogBufferSeconds	Integer	Unknown	[default to 40]
clientApiKey	String	apiKey to be used for all other requests	[default to null]
clientBPSCeiling	Integer	Unknown	[default to 18432]
clientDisconnectTimeout	Integer	Unknown	[default to 30000]
clientNetDispatchThread	Boolean	Unknown	[optional] [default to false]
clientNetDispatchThreadMobile	Boolean	Unknown	[default to true]
clientNetInThread	Boolean	Unknown	[optional] [default to false]
clientNetInThread2	Boolean	Unknown	[optional] [default to false]
clientNetInThreadMobile	Boolean	Unknown	[optional] [default to false]
clientNetInThreadMobile2	Boolean	Unknown	[optional] [default to false]
clientNetOutThread	Boolean	Unknown	[optional] [default to false]
clientNetOutThread2	Boolean	Unknown	[optional] [default to false]
clientNetOutThreadMobile	Boolean	Unknown	[optional] [default to false]
clientNetOutThreadMobile2	Boolean	Unknown	[optional] [default to false]
clientQR	Integer	Unknown	[optional] [default to 1]
clientReservedPlayerBPS	Integer	Unknown	[default to 7168]
clientSentCountAllowance	Integer	Unknown	[default to 15]
constants	APIConfigConstants		[default to null]
contactEmail	String	VRChat's contact email	[default to null]
copyrightEmail	String	VRChat's copyright-issues-related email	[default to null]
copyrightFormUrl	String	VRChat's DMCA claim webform url	[default to null]
currentPrivacyVersion	Integer	Current version number of the Privacy Agreement	[default to 1]
currentTOSVersion	Integer	Current version number of the Terms of Service	[default to null]
defaultAvatar	String		[default to null]
defaultStickerSet	String		[default to null]
devLanguageCodes	List	Unknown	[optional] [default to null]
devSdkUrl	String	Link to download the development SDK, use downloadUrls instead	[default to null]
devSdkVersion	String	Version of the development SDK	[default to null]
dis-countdown	Date	Unknown, "dis" maybe for disconnect?	[default to null]
disableAVProInProton	Boolean	Unknown	[optional] [default to false]
disableAvatarCopying	Boolean	Toggles if copying avatars should be disabled	[default to false]
disableAvatarGating	Boolean	Toggles if avatar gating should be disabled. Avatar gating restricts uploading of avatars to people with the `system_avatar_access` Tag or `admin_avatar_access` Tag	[default to false]
disableCaptcha	Boolean	Unknown	[optional] [default to true]
disableCommunityLabs	Boolean	Toggles if the Community Labs should be disabled	[default to false]
disableCommunityLabsPromotion	Boolean	Toggles if promotion out of Community Labs should be disabled	[default to false]
disableEmail	Boolean	Unknown	[default to false]
disableEventStream	Boolean	Toggles if Analytics should be disabled.	[default to false]
disableFeedbackGating	Boolean	Toggles if feedback gating should be disabled. Feedback gating restricts submission of feedback (reporting a World or User) to people with the `system_feedback_access` Tag.	[default to false]
disableFrontendBuilds	Boolean	Unknown, probably toggles compilation of frontend web builds? So internal flag?	[default to false]
disableGiftDrops	Boolean	Toggles if gift drops should be disabled	[default to false]
disableHello	Boolean	Unknown	[default to false]
disableOculusSubs	Boolean	Toggles if signing up for Subscriptions in Oculus is disabled or not.	[default to false]
disableRegistration	Boolean	Toggles if new user account registration should be disabled.	[default to false]
disableSteamNetworking	Boolean	Toggles if Steam Networking should be disabled. VRChat these days uses Photon Unity Networking (PUN) instead.	[default to true]
disableTwoFactorAuth	Boolean	Toggles if 2FA should be disabled.	[default to false]
disableUdon	Boolean	Toggles if Udon should be universally disabled in-game.	[default to false]
disableUpgradeAccount	Boolean	Toggles if account upgrading "linking with Steam/Oculus" should be disabled.	[default to false]
downloadLinkWindows	String	Download link for game on the Oculus Rift website.	[default to null]
downloadUrls	APIConfigDownloadURLList		[default to null]
dynamicWorldRows	Set	Array of DynamicWorldRow objects, used by the game to display the list of world rows	[default to null]
economyLedgerBackfill	Boolean	Unknown	[default to null]
economyLedgerMigrationStop	String	Unknown	[default to null]
economyLedgerMode	String	Unknown	[default to null]
economyPauseEnd	Date	Unknown	[default to null]
economyPauseStart	Date	Unknown	[default to null]
economyPurchaseRepairEnabled	Boolean	Unknown	[default to null]
economyState	Integer	Unknown	[default to 1]
events	APIConfigEvents		[default to null]
forceUseLatestWorld	Boolean	Unknown	[default to true]
giftDisplayType	String	Display type of gifts	[default to null]
googleApiClientId	String	Unknown	[default to 827942544393-r2ouvckvouldn9dg9uruseje575e878f.apps.googleusercontent.com]
homeWorldId	String	WorldID be "offline" on User profiles if you are not friends with that user.	[default to null]
homepageRedirectTarget	String	Redirect target if you try to open the base API domain in your browser	[default to https://hello.vrchat.com]
hubWorldId	String	WorldID be "offline" on User profiles if you are not friends with that user.	[default to null]
imageHostUrlList	List	A list of explicitly allowed origins that worlds can request images from via the Udon's VRCImageDownloader#DownloadImage.	[default to null]
iosAppVersion	List	Current app version for iOS	[default to null]
iosVersion	APIConfig_iosVersion		[default to null]
jobsEmail	String	VRChat's job application email	[default to null]
maxUserEmoji	Integer	The maximum number of custom emoji each user may have at a given time.	[default to 18]
maxUserStickers	Integer	The maximum number of custom stickers each user may have at a given time.	[default to 18]
minSupportedClientBuildNumber	APIConfig_minSupportedClientBuildNumber		[default to null]
minimumUnityVersionForUploads	String	Minimum Unity version required for uploading assets	[default to 2019.0.0f1]
moderationEmail	String	VRChat's moderation related email	[default to null]
notAllowedToSelectAvatarInPrivateWorldMessage	String	Used in-game to notify a user they aren't allowed to select avatars in private worlds	[default to null]
offlineAnalysis	APIConfig_offlineAnalysis		[default to null]
photonNameserverOverrides	List	Unknown	[default to null]
photonPublicKeys	List	Unknown	[default to null]
player-url-resolver-sha1	String	Currently used youtube-dl.exe hash in SHA1-delimited format	[default to null]
player-url-resolver-version	String	Currently used youtube-dl.exe version	[default to null]
publicKey	String	Public key, hex encoded	[default to null]
reportCategories	Map	Categories available for reporting objectionable content	[default to null]
reportFormUrl	String	URL to the report form	[default to https://help.vrchat.com/hc/en-us/requests/new?ticket_form_id=1500000182242&tf_360056455174=user_report&tf_360057451993={userId}&tf_1500001445142={reportedId}&tf_subject={reason} {category} By {contentType} {reportedName}&tf_description={description}]
reportOptions	Map	Options for reporting content. Select a key+value from this mapping as the `type` of the report. Select one key+value from the object at reportOptions[type] as the `category` of the report. reportCategories[category] contains user-facing text to display for all possible categories. Select one value from the array at reportOptions[type][category] as the `reason` of the report. reportReasons[reason] contains user-facing text to display for all possible categories.	[default to null]
reportReasons	Map	Reasons available for submitting a report	[default to null]
requireAgeVerificationBetaTag	Boolean		[default to null]
sdkDeveloperFaqUrl	String	Link to the developer FAQ	[default to null]
sdkDiscordUrl	String	Link to the official VRChat Discord	[default to null]
sdkNotAllowedToPublishMessage	String	Used in the SDK to notify a user they aren't allowed to upload avatars/worlds yet	[default to null]
sdkUnityVersion	String	Unity version supported by the SDK	[default to null]
stringHostUrlList	List	A list of explicitly allowed origins that worlds can request strings from via the Udon's VRCStringDownloader.LoadUrl.	[default to null]
supportEmail	String	VRChat's support email	[default to null]
supportFormUrl	String	VRChat's support form	[default to null]
timeOutWorldId	String	WorldID be "offline" on User profiles if you are not friends with that user.	[default to null]
timekeeping	Boolean	Unknown	[default to true]
tutorialWorldId	String	WorldID be "offline" on User profiles if you are not friends with that user.	[default to null]
updateRateMsMaximum	Integer	Unknown	[default to null]
updateRateMsMinimum	Integer	Unknown	[default to null]
updateRateMsNormal	Integer	Unknown	[default to null]
updateRateMsUdonManual	Integer	Unknown	[default to null]
uploadAnalysisPercent	Integer	Unknown	[default to null]
urlList	List	List of allowed URLs that bypass the "Allow untrusted URL's" setting in-game	[default to null]
useReliableUdpForVoice	Boolean	Unknown	[default to false]
viveWindowsUrl	String	Download link for game on the Steam website.	[default to null]
websocketMaxFriendsRefreshDelay	Integer	Unknown	[default to 900]
websocketQuickReconnectTime	Integer	Unknown	[default to 2]
websocketReconnectMaxDelay	Integer	Unknown	[default to 2]
whiteListedAssetUrls	List	List of allowed URLs that are allowed to host avatar assets	[default to null]

[Back to Model list] [Back to API list] [Back to README]