Skip to main content
POST
/
api-login
Get JWT token
curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api-login \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "edge-user-01",
  "password": "<string>",
  "uuid": "<string>",
  "sessionId": "<string>",
  "totpToken": "<string>"
}
'
"`{ \"success\": true, \"token\": \"A372jdhe.ad3r4gfrg\" }`"

Documentation Index

Fetch the complete documentation index at: https://docs.edgeimpulse.com/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json
​
username
string
required

Username or e-mail address

Example:

"edge-user-01"

​
password
string
required

Password

​
uuid
string

Evaluation user UUID

​
ssoType
enum<string>
Available options:
browser,
cli
​
sessionId
string

Session ID

​
totpToken
string

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.

Response

200 - application/json

OK

​
success
boolean
required

Whether the operation succeeded

​
error
string

Optional error description (set if 'success' was false)

​
token
string

JWT token, to be used to log in in the future through JWTAuthentication

​
redirectUrl
string

Redirect URL to follow to complete login