Synthesis VR API – Local API

Table of Contents

How Can We Help?

You are here:
The local API is a special URL that runs on every of your VR stations and can be used for building third-party services and functionalities. The API URL is:
  • http://localhost:8080/control/<API_COMMAND>
Command Description
status Provides a way to check the if SynthesisVR is running well. It should contain “status”:1 in the response
status/hmd Represents if the HMD is currently connected to SteamVR. Returns true or false
status/controllers Returns the status of all connected controllers – their battery level, if they are currently charging and if they are wireless controllers
status/hmdreboot Stops SteamVR, awaits for 15 seconds and starts SteamVR
idleplayback/(true|false) Enables/Disables the Idle Playback functionality

Sign Up For Your Trial