logo
Docs
Authentication

Authentication

Let's get you started with Oxygen API Authentication

Below is a simple three-step guide to generating an API key in Oxygen:

The secret key

Navigate to the API keys panel to generate the API key that will be used in your requests.

Copy the secret key

You will not be able to retrieve the secret key once it is lost. This is the only moment you will be able to view it. If lost, you will need to generate a new one.

Use the secret key

All API requests should include your secret key in a Authorization OR x-api-key HTTP header as follows :

Authorization: Bearer oxy-xxxxxxxxx 
x-api-key: oxy-xxxxxxxxx

To use the API, you will need to top up your account, as there is no free tier available. This is primarily to prevent duplicate accounts and malicious abuse.

A brief 3min video explaining what Bearer tokens are and why they are used