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.

API authentication types

Security Scheme	Type	Input	Name
ApiKeyAuthentication	apiKey	header	x-api-key
JWTAuthentication	apiKey	cookie	jwt
JWTHttpHeaderAuthentication	apiKey	header	x-jwt-token

API key

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.

Edge Impulse project API keys

JWT token

A JWT token can be acquired via the Edge Impulse API "Get JWT Token" with your Edge Impulse username and password.

Example

curl --request POST \
--url https://studio.edgeimpulse.com/v1/api-login \
--header 'content-type: application/json' \
--header 'x-api-key: ei_...' \
--data-raw '{"username": "edge-user-01", "password": "reprehenderit ea"}'

Test the API requests from the API Documentation

If you want to test your API requests directly from this documentation, you can use the provided widget:

Test API request

And set your x-api-key or x-jwt-token header or your jwt cookie:

Set authentication header