Overview

Authentication

Authentication methods for AlphaX API
View as Markdown

For every request to the AlphaX API, we require a API Key Token for authentication. This token is a unique identifier that allows you to access the API securely.

To obtain your API Key Token, follow these steps:

  1. Log in to your AlphaX account (Director, HR, or Developer role).
  2. Navigate to the “Developer” menu in the dashboard.
  3. Click on “Create new API Key” to generate a new token.
  4. Copy the generated token and keep it secure, as it will be used for all your API requests.

When making API requests, include the X-Api-Key header of your HTTP request. The format should be as follows:

X-Api-Key: <YOUR_API_KEY_TOKEN>

API Key Token only show once when you create it, so make sure to copy and store it securely. If you lose your token, you will need to generate a new one.