API Keys

To access the Lucid APIs, you will need an API key. Your organization's account may have one or more API keys associated with it. API keys may have different scoping or permissions associated with them; that is, some API keys may only work on a subset of endpoints depending on your account type and level of permission.

For help requesting or accessing an API key, please contact us directly.

The Lucid team will never ask you for your API key. If there is a problem with one, we will just issue you a new one. If someone is asking you for your key, please do not give it to them and report the matter to us.

API Keys

API keys are issued as random strings of characters. Authentication is done at the HTTP header level by applying your API key in the apikey field. For example, the following demonstrates how to send a sample request to a mock endpoint.

curl -X 'POST' \
  'https://<your-server>/v1/recommend/train' \
  -H 'accept: application/json' \
  -H 'apikey: [ENTER YOUR API KEY]' \
  -H 'Content-Type: application/json'

Last updated