The Onyx API input and output formats are specified by Protocol Buffers, known colloquially as protobufs. Unlike typical protobufs endpoints, the Onyx endpoints support JSON for input and output in addition to the protobufs binary format. To use JSON in both the input and the output, specify the headers "Content-Type: application/json" and "Accept: application/json" in the request.

API keys are currently optional, and are included in the HTTP header onyx-api-key; you can request keys from Onyx on Discord server. In the future, API keys will be required to access the API.

Last updated