Edge Impulse API
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 API Authentication Types.
The API is available at:
https://studio.edgeimpulse.com/v1
The API is described in OpenAPI format, which can be used to generate clients in many languages. The OpenAPI definition file is located here.
Jobs started through the API are subject to the same usage limits (such as compute time used) as through the studio UI.
The Edge Impulse API is also available as a Postman Workspace, you can use this site to test the Edge Impulse API and generate code snippets for various languages including Python, cURL, HTTP, etc. Our workspace is available within the Edge Impulse Postman organization.
To use the Postman workspace, generate one of the below authentication types and input the key/token into the Postman Pre-request script & variables, you can then run the Edge Impulse API in your browser via the Postman Send buttons.
Security Scheme | Type | Input | Name |
|---|---|---|---|
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.
Edge Impulse project API keys
A JWT token can be acquired via the Edge Impulse API "Get JWT Token" with your Edge Impulse username and password.
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"}'
Last modified 8mo ago