Get a JWT token to authenticate with the API.
Username or e-mail address
"edge-user-01"Password
Evaluation user UUID
Session ID
TOTP Token. Required if a user has multi-factor authentication with a TOTP token enabled. If a user has MFA enabled, but no totpToken is submitted; then an error starting with "ERR_TOTP_TOKEN IS REQUIRED" is returned. Use this to then prompt for an MFA token and re-login.
OK
Whether the operation succeeded
Optional error description (set if 'success' was false)
JWT token, to be used to log in in the future through JWTAuthentication
Redirect URL to follow to complete login
There are two ways of authenticating with the API. Via an API key (tied to a project) or via the username / password of a user. For most programmatic access we suggest you use API keys.
ApiKeyAuthentication
apiKey
header
x-api-key
JWTAuthentication
apiKey
cookie
jwt
JWTHttpHeaderAuthentication
apiKey
header
x-jwt-token
An Edge Impulse API key can be obtained through your Edge Impulse Studio project's dashboard. At the top of the page, click on the Keys button to see your project's available API keys, and to generate new keys.
A JWT token can be acquired via the Edge Impulse API "Get JWT Token" with your Edge Impulse username and password.
Example
If you want to test your API requests directly from this documentation, you can use the provided widget:
And set your x-api-key or x-jwt-token header or your jwt cookie:
