API Key Authentication

Your API key is a token that is used to authenticate and authorize API calls made to Cerebrum API endpoints. You will be provided with instructions on how to create this API key in our Neuron authentication portal upon onboarding. Your API key must be kept secure and must not be shared with unauthorized users.

To use the API key in your API calls, include it in a header parameter titled apikey. The value of this header parameter should be the API key that you obtained from the Neuron authentication portal, for example: apikey: "ABC123.8LW4F5U3T2V0XGYSMNEO" (this is not a real API key).

The API key is used to validate that the request is authorized and that the user has the appropriate permissions to access the requested resources or perform the requested operation. If the API key is missing or invalid, the Cerebrum API will return an error response indicating that the request is unauthorized.

API keys are tied to a user, and are unique per organization. If you are an integration partner working with Cerebrum to integrate a Cerebrum product across multiple organizations, you will need to create a dedicated API key user account per organization, and then generate and store a unique API key for each user<>organization pair.