Manage and use API keys

What can I use the API key for?

Refer to the Lumicast API documentation for the full list of endpoints. The API docs button on the API keys page links there too.

This is the same API that the Lumicast website uses, so an API key gives you full control over every feature you grant permission to.

WARNING

Be careful who gets access to your API keys. Never give a key more permissions than it needs.

Creating an API key

1. In the main navigation, under Settings, click Workspace.
2. Open API keys.
3. Click Create API key.
4. Enter an API key name and select the permissions the key should have.
5. Click Create. Copy the key shown — it will be hidden after you close the dialog.

Using the API key

The base URL for the API is https://api.lumicast.com. Authenticate your requests by adding an Authorization header:

Authorization: Bearer <YOUR_API_KEY>