API Docs

The API documentation project allows developers to build features that connect them to VRChat. The documentation is written in a standardised format called OpenAPI, providing capabilities for automatic documentation and SDK generation in a variety of languages.

The OpenAPI Specification defines a standard, programming language-agnostic interface description for HTTP APIs, which allows both humans and computers to discover and understand the capabilities of a service without requiring access to source code, additional documentation, or inspection of network traffic. When properly defined via OpenAPI, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. Similar to what interface descriptions have done for lower-level programming, the OpenAPI Specification removes guesswork in calling a service.

The produced outcome is something of surprising quality and allows us to work quickly and efficiently in keeping the documentation up to date. Adding new endpoints or correcting something that's outdated can be fixed and downstreamed into all the SDKs in matter of minutes. This helps to ensure that even during periods of low contribution it is still possible to keep the documentation up to speed with the public API.

Getting Started

The Quickstart is the fastest way to start using VRChat's API. If you are a first-time user, it is strongly recommended to follow the Quickstart instructions. Focusing on getting your environment up and running, and getting your account logged in, allows you to start exploring and playing around with the data immediately.