Introduction

​

Authentication

To ensure secure access to the Companion API, authentication is required. This is accomplished through the use of API keys. To obtain an API key, please visit our Discord server and request one. All requests must include a valid X-Api-Key header.

It is important to note that the API keys for the Companion API are separate and distinct from those used for the Websocket API.

​

Status Codes

200 -> Successful Request

404 -> Resource Not Found

403 -> Forbidden

429 -> Rate Limited

Please note that invalid paths will return a 404 error, and incorrect X-Api-Key headers will result in a 403 error.

​

Rate Limit

All endpoints are rate-limited at 10 requests per second. Additional requests will receive a 429 status code until the limit is reset.