v6 documentation is incomplete, want to contribute?

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.

Requests made through this page are proxied through an intermediary server due to Cross-Origin Resource Sharing restrictions.

GET
/config

Response Body

application/json

curl -X GET "https://api.vrchat.cloud/api/1/config"
{
  "VoiceEnableDegradation": false,
  "VoiceEnableReceiverLimiting": true,
  "accessLogsUrls": {
    "Default": "https://help.vrchat.com/hc/en-us/articles/9521522810899-Where-do-I-find-my-output-logs#h_01HT1ZV67JGKX5AE4R1P28XMXR",
    "Pico": "https://help.vrchat.com/hc/en-us/articles/9521522810899-Where-do-I-find-my-output-logs#h_01HT1ZV67JGKX5AE4R1P28XMXR",
    "Quest": "https://help.vrchat.com/hc/en-us/articles/9521522810899-Where-do-I-find-my-output-logs#h_01HT1ZV67JGKX5AE4R1P28XMXR",
    "XRElite": "https://help.vrchat.com/hc/en-us/articles/9521522810899-Where-do-I-find-my-output-logs#h_01HT1ZV67JGKX5AE4R1P28XMXR"
  },
  "address": "string",
  "ageVerificationInviteVisible": true,
  "ageVerificationP": true,
  "ageVerificationStatusVisible": true,
  "analysisMaxRetries": 0,
  "analysisRetryInterval": 0,
  "announcements": [
    {
      "name": "string",
      "text": "string"
    }
  ],
  "analyticsSegment_NewUI_PctOfUsers": 0,
  "analyticsSegment_NewUI_Salt": "string",
  "availableLanguageCodes": [
    "string"
  ],
  "availableLanguages": [
    "string"
  ],
  "avatarPerfLimiter": {
    "AndroidMobile": {
      "maxSeats": 0
    },
    "PC": {
      "maxSeats": 0
    },
    "Pico": {
      "maxSeats": 0
    },
    "Quest": {
      "maxSeats": 0
    },
    "XRElite": {
      "maxSeats": 0
    },
    "iOSMobile": {
      "maxSeats": 0
    }
  },
  "chatboxLogBufferSeconds": 40,
  "clientApiKey": "string",
  "clientBPSCeiling": 18432,
  "clientDisconnectTimeout": 30000,
  "clientNetDispatchThread": false,
  "clientNetDispatchThreadMobile": true,
  "clientNetInThread": false,
  "clientNetInThread2": false,
  "clientNetInThreadMobile": false,
  "clientNetInThreadMobile2": false,
  "clientNetOutThread": false,
  "clientNetOutThread2": false,
  "clientNetOutThreadMobile": false,
  "clientNetOutThreadMobile2": false,
  "clientQR": 1,
  "clientReservedPlayerBPS": 7168,
  "clientSentCountAllowance": 15,
  "constants": {
    "GROUPS": {
      "CAPACITY": 100000,
      "GROUP_TRANSFER_REQUIREMENTS": [
        "string"
      ],
      "MAX_INVITES_REQUESTS": 50,
      "MAX_JOINED": 100,
      "MAX_JOINED_PLUS": 200,
      "MAX_LANGUAGES": 10,
      "MAX_LINKS": 3,
      "MAX_MANAGEMENT_ROLES": 5,
      "MAX_OWNED": 5,
      "MAX_ROLES": 50
    },
    "INSTANCE": {
      "POPULATION_BRACKETS": {
        "CROWDED": {
          "max": 0,
          "min": 0
        },
        "FEW": {
          "max": 0,
          "min": 0
        },
        "MANY": {
          "max": 0,
          "min": 0
        }
      }
    },
    "LANGUAGE": {
      "SPOKEN_LANGUAGE_OPTIONS": {
        "property1": "string",
        "property2": "string"
      }
    }
  },
  "contactEmail": "string",
  "copyrightEmail": "string",
  "currentPrivacyVersion": 1,
  "currentTOSVersion": 7,
  "defaultAvatar": "avtr_912d66a4-4714-43b8-8407-7de2cafbf55b",
  "defaultStickerSet": "string",
  "devLanguageCodes": [
    "string"
  ],
  "devSdkUrl": "string",
  "devSdkVersion": "string",
  "dis-countdown": "2019-08-24T14:15:22Z",
  "disableAVProInProton": false,
  "disableAvatarCopying": false,
  "disableAvatarGating": false,
  "disableCommunityLabs": false,
  "disableCommunityLabsPromotion": false,
  "disableEmail": false,
  "disableCaptcha": true,
  "disableEventStream": false,
  "disableFeedbackGating": false,
  "disableFrontendBuilds": false,
  "disableGiftDrops": false,
  "disableHello": false,
  "disableOculusSubs": false,
  "disableRegistration": false,
  "disableSteamNetworking": true,
  "disableTwoFactorAuth": false,
  "disableUdon": false,
  "disableUpgradeAccount": false,
  "downloadLinkWindows": "string",
  "downloadUrls": {
    "sdk2": "string",
    "sdk3-avatars": "string",
    "sdk3-worlds": "string",
    "vcc": "string",
    "bootstrap": "string"
  },
  "dynamicWorldRows": [
    {
      "index": 0,
      "name": "string",
      "platform": "string",
      "sortHeading": "string",
      "sortOrder": "string",
      "sortOwnership": "string",
      "tag": "string",
      "type": "avatar"
    }
  ],
  "economyPauseEnd": "string",
  "economyPauseStart": "string",
  "economyState": 1,
  "events": {
    "distanceClose": 0,
    "distanceFactor": 0,
    "distanceFar": 0,
    "groupDistance": 0,
    "maximumBunchSize": 0,
    "notVisibleFactor": 0,
    "playerOrderBucketSize": 0,
    "playerOrderFactor": 0,
    "slowUpdateFactorThreshold": 0,
    "viewSegmentLength": 0
  },
  "forceUseLatestWorld": true,
  "giftDisplayType": "string",
  "googleApiClientId": "827942544393-r2ouvckvouldn9dg9uruseje575e878f.apps.googleusercontent.com",
  "homeWorldId": "wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd",
  "homepageRedirectTarget": "https://hello.vrchat.com",
  "hubWorldId": "wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd",
  "imageHostUrlList": [
    "string"
  ],
  "jobsEmail": "string",
  "minSupportedClientBuildNumber": {
    "AppStore": {
      "minBuildNumber": 0,
      "redirectionAddress": "string"
    },
    "Default": {
      "minBuildNumber": 0,
      "redirectionAddress": "string"
    },
    "Firebase": {
      "minBuildNumber": 0,
      "redirectionAddress": "string"
    },
    "FirebaseiOS": {
      "minBuildNumber": 0,
      "redirectionAddress": "string"
    },
    "GooglePlay": {
      "minBuildNumber": 0,
      "redirectionAddress": "string"
    },
    "PC": {
      "minBuildNumber": 0,
      "redirectionAddress": "string"
    },
    "PicoStore": {
      "minBuildNumber": 0,
      "redirectionAddress": "string"
    },
    "QuestAppLab": {
      "minBuildNumber": 0,
      "redirectionAddress": "string"
    },
    "QuestStore": {
      "minBuildNumber": 0,
      "redirectionAddress": "string"
    },
    "TestFlight": {
      "minBuildNumber": 0,
      "redirectionAddress": "string"
    },
    "XRElite": {
      "minBuildNumber": 0,
      "redirectionAddress": "string"
    }
  },
  "minimumUnityVersionForUploads": "2019.0.0f1",
  "moderationEmail": "string",
  "notAllowedToSelectAvatarInPrivateWorldMessage": "string",
  "offlineAnalysis": {
    "android": true,
    "standalonewindows": true
  },
  "photonNameserverOverrides": [
    "string"
  ],
  "photonPublicKeys": [
    "string"
  ],
  "reportCategories": {
    "avatar": {
      "description": "string",
      "title": "string",
      "text": "string",
      "tooltip": "string"
    },
    "avatarpage": {
      "description": "string",
      "title": "string",
      "text": "string",
      "tooltip": "string"
    },
    "behavior": {
      "description": "string",
      "title": "string",
      "text": "string",
      "tooltip": "string"
    },
    "chat": {
      "description": "string",
      "title": "string",
      "text": "string",
      "tooltip": "string"
    },
    "emoji": {
      "description": "string",
      "title": "string",
      "text": "string",
      "tooltip": "string"
    },
    "environment": {
      "description": "string",
      "title": "string",
      "text": "string",
      "tooltip": "string"
    },
    "groupstore": {
      "description": "string",
      "title": "string",
      "text": "string",
      "tooltip": "string"
    },
    "image": {
      "description": "string",
      "title": "string",
      "text": "string",
      "tooltip": "string"
    },
    "text": {
      "description": "string",
      "title": "string",
      "text": "string",
      "tooltip": "string"
    },
    "sticker": {
      "description": "string",
      "title": "string",
      "text": "string",
      "tooltip": "string"
    },
    "warnings": {
      "description": "string",
      "title": "string",
      "text": "string",
      "tooltip": "string"
    },
    "worldimage": {
      "description": "string",
      "title": "string",
      "text": "string",
      "tooltip": "string"
    },
    "worldstore": {
      "description": "string",
      "title": "string",
      "text": "string",
      "tooltip": "string"
    }
  },
  "reportFormUrl": "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": {
    "avatar": {
      "avatar": [
        "string"
      ],
      "avatarpage": [
        "string"
      ],
      "warnings": [
        "string"
      ]
    },
    "group": {
      "groupstore": [
        "string"
      ],
      "image": [
        "string"
      ],
      "text": [
        "string"
      ]
    },
    "user": {
      "behavior": [
        "string"
      ],
      "chat": [
        "string"
      ],
      "emoji": [
        "string"
      ],
      "image": [
        "string"
      ],
      "sticker": [
        "string"
      ],
      "text": [
        "string"
      ]
    },
    "world": {
      "environment": [
        "string"
      ],
      "text": [
        "string"
      ],
      "warnings": [
        "string"
      ],
      "worldimage": [
        "string"
      ],
      "worldstore": [
        "string"
      ]
    }
  },
  "reportReasons": {
    "billing": {
      "text": "string",
      "tooltip": "string"
    },
    "botting": {
      "text": "string",
      "tooltip": "string"
    },
    "cancellation": {
      "text": "string",
      "tooltip": "string"
    },
    "copyright": {
      "text": "string",
      "tooltip": "string"
    },
    "fraud": {
      "text": "string",
      "tooltip": "string"
    },
    "gore": {
      "text": "string",
      "tooltip": "string"
    },
    "hacking": {
      "text": "string",
      "tooltip": "string"
    },
    "harassing": {
      "text": "string",
      "tooltip": "string"
    },
    "hateful": {
      "text": "string",
      "tooltip": "string"
    },
    "impersonation": {
      "text": "string",
      "tooltip": "string"
    },
    "inappropriate": {
      "text": "string",
      "tooltip": "string"
    },
    "leaking": {
      "text": "string",
      "tooltip": "string"
    },
    "malicious": {
      "text": "string",
      "tooltip": "string"
    },
    "missing": {
      "text": "string",
      "tooltip": "string"
    },
    "nudity": {
      "text": "string",
      "tooltip": "string"
    },
    "renewal": {
      "text": "string",
      "tooltip": "string"
    },
    "security": {
      "text": "string",
      "tooltip": "string"
    },
    "service": {
      "text": "string",
      "tooltip": "string"
    },
    "sexual": {
      "text": "string",
      "tooltip": "string"
    },
    "technical": {
      "text": "string",
      "tooltip": "string"
    },
    "threatening": {
      "text": "string",
      "tooltip": "string"
    },
    "visuals": {
      "text": "string",
      "tooltip": "string"
    }
  },
  "requireAgeVerificationBetaTag": true,
  "sdkDeveloperFaqUrl": "string",
  "sdkDiscordUrl": "string",
  "sdkNotAllowedToPublishMessage": "string",
  "sdkUnityVersion": "string",
  "stringHostUrlList": [
    "string"
  ],
  "supportEmail": "string",
  "supportFormUrl": "string",
  "timekeeping": true,
  "timeOutWorldId": "wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd",
  "tutorialWorldId": "wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd",
  "updateRateMsMaximum": 0,
  "updateRateMsMinimum": 0,
  "updateRateMsNormal": 0,
  "updateRateMsUdonManual": 0,
  "uploadAnalysisPercent": 0,
  "urlList": [
    "string"
  ],
  "useReliableUdpForVoice": false,
  "viveWindowsUrl": "string",
  "whiteListedAssetUrls": [
    "string"
  ],
  "player-url-resolver-version": "string",
  "player-url-resolver-sha1": "string",
  "publicKey": "string",
  "websocketMaxFriendsRefreshDelay": 900,
  "websocketQuickReconnectTime": 2,
  "websocketReconnectMaxDelay": 2
}