Edge Impulse User API
The User API from Edge Impulse — 43 operation(s) for user.
Operations 49
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Ask an LLM
“How do I register a new Edge Impulse account and get a starter project?”
“Can I name the first project when creating a user account?”
Tell an agent
Create user {username} named {name} with email {email}, accepting the privacy policy: {privacyPolicy}.
Sign up {email} as a free user and create a first project called {projectName}.
Ask an LLM
“Can I try the platform with an evaluation account without filling in my details?”
“What creates a temporary evaluation user and drops me straight into a new project?”
Tell an agent
Create an evaluation user and open its new project.
Spin up an anonymous evaluation account so I can try things out.
Ask an LLM
“How do I sign up directly for the Professional plan?”
“When does a new Professional tier account actually get its paid features?”
Tell an agent
Create Professional plan user {username} named {name} with email {email}, privacy policy accepted: {privacyPolicy}.
Register {email} on the paid Professional tier and send them back to {redirectUrlOrigin} after checkout.
POST
/api-user-create-enterprise-trial
Sign up a new user with an enterprise trial · Create enterprise trial user
#
Ask an LLM
“Can a brand-new user sign up and get an enterprise trial organization at the same time?”
“What company details are collected when someone registers for an enterprise trial?”
Tell an agent
Create enterprise trial user {username} named {name} with organization {organizationName}, privacy policy accepted: {privacyPolicy}.
Register new user {username} for an enterprise trial for company {companyName} in {country}.
GET
/api-user-need-to-set-password/{usernameOrEmail}
Check whether a user is registered and needs a password · Get user registration state
#
Ask an LLM
“Is there already an account for this email, and does it still need a password set?”
“Can I tell if a username is registered before showing a login form?”
Tell an agent
Check whether {usernameOrEmail} is registered and needs to set a password.
Look up the registration state of {usernameOrEmail}.
Ask an LLM
“What account details does Edge Impulse have for me?”
“Can I fetch my profile without the long list of projects?”
Tell an agent
Show my user profile.
Get my account info and set exclude projects to {excludeProjects}.
Ask an LLM
“How do I change my display name or job title on my own account?”
“Can I set my timezone and project sort order on my profile?”
Tell an agent
Change my name to {name}.
Set my own job title to {jobTitle} and company to {companyName}.
Ask an LLM
“How do I permanently close my own account?”
“Do I need my password or an MFA code to delete my account?”
Tell an agent destructive · confirm first
Delete my account, confirming with password {password}.
Close my own account using MFA code {totpToken}.
Ask an LLM
“Which projects do I have access to across every whitelabel?”
“Can I get just my project list without the rest of my profile?”
Tell an agent
List all my projects.
Show every project on my account regardless of whitelabel.
POST
/api/user/convert
Convert my evaluation account to a regular one · Convert current evaluation user
#
Ask an LLM
“I've been using an evaluation account — how do I keep it as a real account?”
“Can I turn my trial evaluation login into a permanent user with my own username?”
Tell an agent
Convert my evaluation account to user {username} named {name}, email {email}, password {password}, privacy policy accepted: {privacyPolicy}.
Upgrade my evaluation login to a regular account under {email}.
Ask an LLM
“Where do I enter the activation code I got by email for my own account?”
“What's needed to activate my newly created account?”
Tell an agent
Activate my account with code {code}.
Use activation code {code} to activate the account I'm logged in with.
Ask an LLM
“I never received my activation email — can I get a new code?”
“What resends the activation code for the account I'm signed in with?”
Tell an agent
Send me a new activation code.
Resend the activation email for my own account.
POST
/api/user/create-developer-profile
Create a developer profile for my account · Create developer profile
#
Ask an LLM
“How do I set up a developer profile on my Edge Impulse account?”
“Can I add a developer profile to the user I'm logged in as?”
Tell an agent
Create a developer profile for me.
Set up my developer profile now.
Ask an LLM
“Can I start an enterprise trial from my existing account?”
“Is it possible to run more than one enterprise trial on the same account?”
Tell an agent
Start an enterprise trial for me with organization {organizationName}.
Begin my enterprise trial for {companyName}, use case {useCase}.
Ask an LLM
“What emails has Edge Impulse sent to my account?”
“Can I check whether my activation email was actually sent to me?”
Tell an agent
List the emails Edge Impulse has sent me.
Show my own account's email history.
Ask an LLM
“How do I set a profile picture on my own account?”
“Can I replace my avatar with a new photo?”
Tell an agent
Upload {photo} as my profile photo.
Set my avatar to {photo}.
Ask an LLM
“Can I remove my profile picture entirely?”
“What deletes the avatar on my account?”
Tell an agent destructive · confirm first
Delete my profile photo.
Remove my avatar.
Ask an LLM
“How do I change my password if I know my current one?”
“Do I need my old password to set a new one on my account?”
Tell an agent
Change my password from {currentPassword} to {newPassword}.
Update the password on my account to {newPassword}, current one is {currentPassword}.
Ask an LLM
“Which organizations am I a member of?”
“Can I see all the teams my account is part of?”
Tell an agent
List my organizations.
Show every organization I'm a member of.
Ask an LLM
“Which organizational storage buckets do I have access to?”
“Can I see all the data buckets available to my account?”
Tell an agent
List the storage buckets I can access.
Show me every organization bucket available to my account.
POST
/api/user/by-third-party-activation-code
Look up a user by third-party activation code · Get user by third party activation code
#
Ask an LLM
“Can I find out which user a third-party activation code belongs to?”
“What user details come back for a partner-issued activation code?”
Tell an agent
Look up the user for third-party activation code {activationCode}.
Find who third-party activation code {activationCode} was issued to.
POST
/api/user/activate-by-third-party-activation-code
Activate a third-party-created user · Activate user by third party activation code
#
Ask an LLM
“A partner created my account — how do I activate it with their code?”
“What do I need to set when activating an account created by a third party?”
Tell an agent
Activate the third-party account with code {activationCode}, username {username} and password {password}.
Claim partner-created account {activationCode} as {username}.
Ask an LLM
“How do I accept the updated Terms of Service on my account?”
“What records my agreement to the Terms of Service?”
Tell an agent
Accept the Terms of Service for my account.
Record that I agree to the latest Terms of Service.
Ask an LLM
“Can I hide a notification banner so it stops showing on my account?”
“What dismisses one of my account notifications?”
Tell an agent
Dismiss notification {notification}.
Stop showing me the {notification} notice.
POST
/api/user/mfa/totp/create-key
Generate a new TOTP key for MFA setup · Generate a new TOTP MFA key
#
Ask an LLM
“How do I get a secret to add Edge Impulse to my authenticator app?”
“Can I generate an MFA key if I already have MFA turned on?”
Tell an agent
Generate a new TOTP MFA key for my account.
Create an authenticator secret so I can begin setting up two-factor login.
Ask an LLM
“How do I turn on two-factor authentication after scanning the key?”
“What code do I need to confirm when enabling MFA?”
Tell an agent
Enable MFA with key {key} and code {totpToken}.
Turn on two-factor login using authenticator code {totpToken} for key {key}.
Ask an LLM
“How do I turn off two-factor authentication?”
“Do I need a current authenticator code to remove MFA?”
Tell an agent destructive · confirm first
Disable MFA on my account using code {totpToken}.
Remove my TOTP key, confirming with {totpToken}.
Ask an LLM
“How do I upgrade my plan and choose monthly or yearly billing?”
“Where does the checkout send me after a subscription upgrade succeeds or is cancelled?”
Tell an agent
Upgrade my subscription with {billingCycle} billing, returning to {successUrl} on success or {cancelUrl} on cancel.
Start a {billingCycle} plan upgrade checkout that redirects to {successUrl} or {cancelUrl}.
Ask an LLM
“How do I cancel my paid plan?”
“Can I tell Edge Impulse why I'm downgrading when I cancel?”
Tell an agent destructive · confirm first
Cancel my subscription.
Cancel my plan with the reason {downgradeReason}.
POST
/api/user/subscription/undo-cancel
Undo a pending subscription cancellation · Undo subscription cancellation
#
Ask an LLM
“I cancelled my plan by mistake — can I keep it before the billing period ends?”
“Is it too late to reverse a cancellation once the billing period has ended?”
Tell an agent
Undo my pending subscription cancellation.
Keep my subscription active and stop the scheduled cancellation.
GET
/api/user/subscription/metrics
Get my billable compute usage · Get user billable compute metrics
#
Ask an LLM
“How much billable compute have I used on my subscription?”
“Where can I see compute metrics that count toward my bill?”
Tell an agent
Show my billable compute metrics.
Get the compute usage on my active subscription.
Ask an LLM
“What profile information is stored for a given user ID?”
“Can I look up another account's details by its user ID?”
Tell an agent
Get user {userId}.
Show the profile of user ID {userId}.
Ask an LLM
“Can I change the name or job title of a user identified by their ID?”
“Which profile fields can be edited for a specific user ID?”
Tell an agent
Rename user {userId} to {name}.
Set the timezone of user {userId} to {timezone}.
Ask an LLM
“Can I delete an account by passing its user ID?”
“Is deleting a user by ID limited to my own account?”
Tell an agent destructive · confirm first
Delete user {userId}, confirming with password {password}.
Remove the account with ID {userId}.
Ask an LLM
“Can I activate an account by user ID using its activation code?”
“What activates a specific user rather than the one I'm logged in as?”
Tell an agent
Activate user {userId} with code {code}.
Use code {code} to activate account ID {userId}.
POST
/api/users/{userId}/request-activation
Resend the activation code for a user · Request activation code
#
Ask an LLM
“Can I trigger a new activation code for a specific user ID?”
“What resends activation for another account rather than my own?”
Tell an agent
Request a new activation code for user {userId}.
Resend the activation email to account ID {userId}.
Ask an LLM
“Which emails were sent to a given user ID?”
“Can I check the email history of a specific account?”
Tell an agent
List emails sent to user {userId}.
Show the email history for account ID {userId}.
Ask an LLM
“Can I set the profile photo of a user by their ID?”
“What uploads an avatar for a specific account rather than mine?”
Tell an agent
Upload {photo} as the profile photo of user {userId}.
Set account {userId}'s avatar to {photo}.
Ask an LLM
“Can I change the password of a user identified by ID?”
“Does changing a user's password by ID still require the current password?”
Tell an agent
Change the password of user {userId} from {currentPassword} to {newPassword}.
Set account {userId}'s password to {newPassword}, current password {currentPassword}.
POST
/api/users/{userId}/set-password
Set a password for a new SSO user · Set password for SSO user
#
Ask an LLM
“I signed up through single sign-on — how do I also set a password?”
“What does a new SSO user need to provide to add a password?”
Tell an agent
Set password {password} for SSO user {userId} using {identityProvider} access token {accessToken}.
Give SSO account {userId} the password {password}, verified by token {accessToken} from {identityProvider}.
Ask an LLM
“Which organizations is a given user a member of?”
“Can I see the organizations for a specific user ID?”
Tell an agent
List organizations for user {userId}.
Show which teams account {userId} belongs to.
Ask an LLM
“Which organizational storage buckets can a particular user reach?”
“Can I audit bucket access for a specific user ID?”
Tell an agent
List the storage buckets user {userId} can access.
Show organization buckets available to account {userId}.
Ask an LLM
“How do I send product feedback to Edge Impulse?”
“Can I get in touch with sales from my account with my company details?”
Tell an agent
Send {type} feedback from user {userId} with subject {subject} and message {body}.
Contact sales as user {userId} about {subject}: {body}, type {type}, work email {workEmail}.
Ask an LLM
“How do I ask to move my account to the Enterprise plan?”
“Can I include my use case and timeline in an Enterprise upgrade request?”
Tell an agent
Send an Enterprise upgrade request for user {userId}.
Request Enterprise for user {userId} with use case {useCase} and timeline {timeline}.
Ask an LLM
“Which enterprise trials has a user started?”
“Has a given user already used up their enterprise trial?”
Tell an agent
List enterprise trials for user {userId}.
Show the trial history of account {userId}.
Ask an LLM
“I forgot my password — how do I get a reset link?”
“Can a password reset email be sent to any registered address?”
Tell an agent
Send a password reset link to {email}.
Email {email} a link to reset their forgotten password.
Ask an LLM
“What do I do with the reset code once I've received it?”
“Can I set a new password using the code from the reset email?”
Tell an agent
Reset the password for {email} to {newPassword} using code {code}.
Use reset code {code} to give {email} the new password {newPassword}.
POST
/api-user-verify-reset-password-code
Check that a password reset code is valid · Verify reset password code
#
Ask an LLM
“Is the reset code I received still valid before I choose a new password?”
“Can I validate a reset code without actually changing the password?”
Tell an agent
Verify reset code {code} for {email}.
Check whether password reset code {code} works for {email}.
POST
/api/user/accept-eula
Accept an End-User License Agreement · Accept End-User License Agreement
#
Ask an LLM
“Some models require a license agreement — how do I accept it?”
“Which EULA do I need to accept to unlock certain tooling?”
Tell an agent
Accept the {name} EULA.
Agree to the license agreement {name} so I can use that model.