Authentication

You'll need to authenticate your requests to access any of the endpoints in BeamAPI. In this guide, we'll look at how authentication works. BeamAPI authenticates your API requests using the user's purchased or assigned API keys. Each API key corresponds to a product plan with specific levels of access. Please reference the Pricing page to see what level access your plan allows.

Authenticate with your API key

In order to authenticate with BeamAPI, you will need your API key — you will find it in the BeamAPI Dashboard.

For GraphQL queries, the API key must be included in the headers in order for the request to be authenticated. For GraphQL subscriptions, the API key must be included in the initial connection payload.

{"api-key": "<YOUR API KEY>"}

Always keep your API key safe and refresh your key in the dashboard if you suspect it has been compromised.

Using a Third-party Library

All of our endpoints except those related to key management use the GraphQL specification. Any community-supported GraphQL client library can be used to access our services.