Contributing

Thanks for your interest in contributing to the VRChat API documentation! The VRChat API serves thousands of developers building applications, tools, and integrations for the VRChat platform.

Your contributions help make this documentation more accurate, comprehensive, and accessible to the entire developer community.

Getting started

Browse open issues

Check out open issues on GitHub for things that need to be done - this is a great place to start contributing.

Join our Discord

Ask questions and discuss contributions with the community in real-time.

Repositories

The VRChat API project is spread across multiple repositories, each serving a different purpose.

The main specification repository contains the OpenAPI specification that defines the VRChat API. This is where most contributions happen, from documenting newly discovered endpoints to refining response schemas that don't quite match the actual API responses.

Common contributions include adding missing endpoints, updating response models when fields are incorrect or missing, improving parameter descriptions, and adding practical examples.f

The related specification-test repository contains automated tests that run against VRChat's live API to validate the accuracy and completeness of the OpenAPI specification.

vrchatapi/specification-test

Language-specific SDK repositories

Each programming language has its own repository with generated SDKs based on the OpenAPI specification. These are automatically generated from the OpenAPI specification and provide type-safe API clients for different programming languages.

vrchatapi/vrchatapi-javascript

vrchatapi/vrchatapi-python

vrchatapi/vrchatapi-csharp

vrchatapi/vrchatapi-dart

vrchatapi/vrchatapi-java

vrchatapi/vrchatapi-rust

Documentation site

This documentation site has its own repository for guides, tutorials, and website improvements.

vrchatapi/vrchat.community

Ways to contribute

Documentation improvements

Fix typos, grammar, or unclear explanations. Add missing information or examples. Improve existing guides and tutorials. Update outdated information.

Code examples

Add practical code examples for different programming languages. Improve existing code samples. Create tutorial projects demonstrating API usage.

API reference

Report missing or incorrect API endpoint documentation. Suggest improvements to parameter descriptions. Contribute to the OpenAPI specification directly.

Community support

Answer questions on Discord. Help other developers troubleshoot API issues. Share your own experiences and best practices.

Before you start

Before jumping in, it's worth doing a quick check to make sure you're not duplicating work or going against the grain. Take a look at the open issues to see if someone's already tackling what you have in mind.

If you're planning something bigger than a small fix, hop into our Discord first - the community is pretty active and can save you time by pointing you in the right direction or letting you know about any quirks you should be aware of.

It's also helpful to browse through recent pull requests to get a feel for what kinds of changes are being accepted and how people structure their contributions.

Need help?

Don't hesitate to reach out if you're unsure about anything:

Discord: Join our Discord server for real-time help and discussion
GitHub Issues: Ask questions directly on relevant issues

We appreciate all contributions, no matter how small. Every improvement helps make the VRChat API more accessible to developers!

VRChat.community