Get started
Authentication
Every call to /v1/detect carries an API key as a bearer token.
Authorization: Bearer elk_live_...Keys belong to a workspace
Keys, balance and usage belong to a workspace, not to a person. Admins create and revoke keys in the console; members can use the playground and see usage and balance but not keys. A workspace can hold up to 20 active keys.
Handling a key
- The full key is shown once, when you create it. We store only a hash, so we cannot show it again. Create a new one if you lose it.
- Call the API from your server. Do not ship a key in a browser or mobile app: anyone who opens it can spend your balance.
- Use one key per service or environment and name it that way, so a revoked key tells you what to fix.
- Revoking a key takes effect on the next call. A leaked key should be revoked straight away.
Failures
A missing, unknown or revoked key returns 401 invalid_api_key. A suspended workspace returns 403 account_suspended. See Errors.
The console itself signs in with an emailed code or link. There are no passwords.