Edge Impulse API
Last updated
Was this helpful?
Last updated
Was this helpful?
The Edge Impulse API exposes programmatic access to most functionality in the studio. You can use the API to edit the labels of many samples at once, train models, or create new impulses. In addition, you can subscribe to events, such as when a new file was processed by the ingestion service. You authenticate with the API using an API Key or with a username/password, see .
The API is available at:
The API is described in , which can be used to generate clients in many languages. The OpenAPI definition file is located .
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.
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:
A JWT token can be acquired via the Edge Impulse API request with your Edge Impulse username and password.