API Introduction

Our API has been designed with developers in mind to make it possible to easily integrate elyxir into your own application.

We are open to implementing API endpoints for more features, if you want to suggest endpoints please contact us in our discord server explaining your use-case and reasoning.

Authentication

In a manner similar to Discord's authentication system, we use token authentication. Each server can have up to one active token for interacting with our API. You should handle it with caution, as it has the potential to be used destructively against your server. We are not responsible for any impacts on your server resulting from poor operational security when handling your token.

Our team will never ask for your API token, you should never share it with anyone claiming to be affiliated with us. If you are concerned that you have been a victim of social engineering, revoke your token immediately and contact our team.

Generate a token

To generate a new API token, you need to run the /api-key generate command. This command can only be run by the owner of the discord server for security reasons.

You can't generate a new API token if you already have one in your server. You will be prompted to firstly revoke the existing token before generating another one.

Revoke a token

To revoke a token, you need to run the /api-key revoke command. This command can only be run by the owner of the discord server for security reasons. Once a token has been revoked, you will no longer be able to send any further requests using it, they will return 401 Unauthorized.