Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Edge Impulse

Edge Impulse User API

The User API from Edge Impulse — 43 operation(s) for user.

Documentation Provider Profile APIs.io OpenAPI GitHub

Edge Impulse User API is one of 34 APIs that Edge Impulse publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 48 operations across 43 paths, and defines 60 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://studio.edgeimpulse.com/v1.

48 operations 43 paths 60 schemas 3 DELETE12 GET33 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://studio.edgeimpulse.com/v1
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Edge Impulse User API declares 3 security schemes for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuthentication). An API key is passed in the cookie as jwt (JWTAuthentication). An API key is passed in the header as x-jwt-token (JWTHttpHeaderAuthentication). By default, every request must be authenticated.

Paths & Operations 48

Across 43 paths, the API surfaces 48 operations — 3 DELETE, 12 GET, 33 POST. Each is listed below with its method, path, parameters, and response codes.

User 48
POST
/api-user-create
Create user
createUser body → 200
POST
/api-user-create-evaluate
Create evaluation user
createEvaluationUser → 200
POST
/api-create-pro-user
Create Professional Tier user
createProTierUser body → 200
POST
/api-user-create-enterprise-trial
Create enterprise trial user
createEnterpriseTrialUser body → 200
GET
/api-user-need-to-set-password/{usernameOrEmail}
Get user registration state
getUserNeedToSetPassword 1 param → 200
GET
/api/user
Get current user
getCurrentUser 1 param → 200
POST
/api/user
Update current user
updateCurrentUser body → 200
DELETE
/api/user
Delete current user
deleteCurrentUser body → 200
GET
/api/user/projects
Get current user projects
getCurrentUserProjects → 200
POST
/api/user/convert
Convert current evaluation user
convertCurrentUser body → 200
POST
/api/user/activate
Activate current user
activateCurrentUser body → 200
POST
/api/user/request-activation
Request activation code
requestActivationCodeCurrentUser → 200
POST
/api/user/create-developer-profile
Create developer profile
createDeveloperProfile → 200
POST
/api/user/trial
Start enterprise trial
startEnterpriseTrial body → 200
GET
/api/user/emails
List emails
listEmailsCurrentUser → 200
POST
/api/user/photo
Upload photo
uploadPhotoCurrentUser body → 200
DELETE
/api/user/photo
Delete photo
deletePhotoCurrentUser → 200
POST
/api/user/change-password
Change password current user
changePasswordCurrentUser body → 200
GET
/api/user/organizations
Get organizations
listOrganizationsCurrentUser → 200
GET
/api/users/buckets
Get buckets current user
listOrganizationBucketsCurrentUser → 200
POST
/api/user/by-third-party-activation-code
Get user by third party activation code
getUserByThirdPartyActivationCode body → 200
POST
/api/user/activate-by-third-party-activation-code
Activate user by third party activation code
activateUserByThirdPartyActivationCode body → 200
POST
/api/user/accept-tos
Accept Terms of Service
acceptTermsOfService → 200
POST
/api/user/dismiss-notification
Dismiss a notification
userDismissNotification body → 200
POST
/api/user/mfa/totp/create-key
Generate a new TOTP MFA key
userGenerateNewTotpMfaKey → 200
POST
/api/user/mfa/totp/set-key
Set TOTP MFA key
userSetTotpMfaKey body → 200
POST
/api/user/mfa/totp/clear
Remove TOTP MFA key
userDeleteTotpMfaKey body → 200
POST
/api/user/subscription/upgrade
Upgrade subscription
userUpgradeSubscription body → 302
POST
/api/user/subscription/cancel
Cancel subscription
userCancelSubscription body → 200
POST
/api/user/subscription/undo-cancel
Undo subscription cancellation
userUndoCancelSubscription → 200
GET
/api/user/subscription/metrics
Get user billable compute metrics
userGetSubscriptionMetrics → 200
GET
/api/users/{userId}
Get user
getUser 1 param → 200
POST
/api/users/{userId}
Update user
updateUser 1 param body → 200
DELETE
/api/users/{userId}
Delete user
deleteUser 1 param body → 200
POST
/api/users/{userId}/activate
Activate user
activateUser 1 param body → 200
POST
/api/users/{userId}/request-activation
Request activation code
requestActivationCodeUser 1 param → 200
GET
/api/users/{userId}/emails
List emails
listEmailsUser 1 param → 200
POST
/api/users/{userId}/photo
Upload photo
uploadPhotoUser 1 param body → 200
POST
/api/users/{userId}/change-password
Change password
changePasswordUser 1 param body → 200
POST
/api/users/{userId}/set-password
Set password for SSO user
setUserPassword 1 param body → 200
GET
/api/users/{userId}/organizations
Get organizations
listOrganizationsUser 1 param → 200
GET
/api/users/{userId}/buckets
Get buckets
listOrganizationBucketsUser 1 param → 200
POST
/api/users/{userId}/feedback
Send feedback
sendUserFeedback 1 param body → 200
POST
/api/users/{userId}/upgrade
Send upgrade request
sendUserUpgradeRequest 1 param body → 200
GET
/api/users/{userId}/trials
Get enterprise trials
listEnterpriseTrialsUser 1 param → 200
POST
/api-user-request-reset-password
Request reset password
requestResetPassword body → 200
POST
/api-user-reset-password
Reset password
resetPassword body → 200
POST
/api-user-verify-reset-password-code
Verify reset password code
verifyResetPassword body → 200

Schemas 60

The contract defines 60 schemas that model the data the API accepts and returns. The most detailed are Project (29 properties), User (18 properties), Organization (15 properties), UserOrganization (15 properties). Each schema is shown below with its type and property counts.

BillingCycle
string
Specifies the frequency at which the subscription fee is billed: - monthly: Billed once every month. - yearly: Billed once every year, often at a discounted ra…
EntitlementLimits
object
5 properties
CreateDeveloperProfileResponse
GetUserResponse
ConvertUserRequest
object
6 properties 5 required
CreateEnterpriseTrialResponse
CreateEvaluationUserResponse
UserProjectsSortOrder
string
ChangePasswordRequest
object
2 properties 2 required
ActivateUserByThirdPartyActivationCodeRequest
object
5 properties 3 required
UserDismissNotificationRequest
object
1 property 1 required
GetUserNeedToSetPasswordResponse
EnterpriseTrial
object
9 properties 8 required
UserGenerateNewMfaKeyResponse
ProjectCollaborator
ActivateUserOrVerifyEmailRequest
object
1 property 1 required
UploadUserPhotoResponse
DeleteUserRequest
object
2 properties
Project
object
29 properties 17 required
UtmParameter
object
SendUserFeedbackRequest
object
8 properties 3 required
ProjectTierEnum
string
The project tier. This is "enterprise" for all organization projects, or the user tier for all user projects.
UserTierEnum
string
The user account tier.
Permission
string
OrganizationMemberRole
string
EnterpriseUpgradeOrTrialExtensionRequest
object
5 properties
UserSubscriptionMetricsResponse
OrganizationUser
StaffInfo
object
3 properties 2 required
UserSetTotpMfaKeyResponse
StartEnterpriseTrialRequest
object
12 properties
TrialNotes
string
Notes about the trial. Free form text. This field is ignored if the trial is requested by a non-admin user.
UserDeleteTotpMfaKeyRequest
object
1 property 1 required
ListOrganizationBucketsUserResponse
UserOrganization
object
15 properties 13 required
User
object
18 properties 9 required
CreateEnterpriseTrialUserRequest
UserSetTotpMfaKeyRequest
object
2 properties 2 required
GetJWTResponse
SetUserPasswordRequest
object
3 properties 3 required
VerifyResetPasswordRequest
object
2 properties 2 required
ListEmailResponse
CreateProTierUserRequest
ListEnterpriseTrialsResponse
UpgradeSubscriptionRequest
object
3 properties 3 required
EntityCreatedResponse
UpdateUserRequest
object
Only fields set in this object will be updated.
6 properties
ListOrganizationsResponse
UserByThirdPartyActivationRequest
object
1 property 1 required
GetUserProjectsResponse
Organization
object
15 properties 10 required
DowngradeSubscriptionRequest
object
1 property
TrialExpirationDate
string
Expiration date of the trial. The trial will be set as expired after this date. There will be a grace period of 30 days after a trial expires before fully dele…
RequestResetPasswordRequest
object
1 property 1 required
CreateUserRequest
object
13 properties 4 required
CreateUserResponse
UploadUserPhotoRequest
object
1 property 1 required
GenericApiResponse
object
2 properties 1 required
UserExperiment
object
5 properties 4 required
ResetPasswordRequest
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

edge-impulse-user-api-openapi.yml Raw ↑

Other APIs Edge Impulse publishes across the network.

Edge Impulse Admin API
AE Profile APIs.io
Edge Impulse Auth API
AE Profile APIs.io
Edge Impulse Canary API
AE Profile APIs.io
Edge Impulse CDN API
AE Profile APIs.io
Edge Impulse Classify API
AE Profile APIs.io
Edge Impulse Deployment API
AE Profile APIs.io
Edge Impulse Devices API
AE Profile APIs.io
Edge Impulse DSP API
AE Profile APIs.io
Edge Impulse EmailVerification API
AE Profile APIs.io
Edge Impulse Export API
AE Profile APIs.io
Edge Impulse FeatureFlags API
AE Profile APIs.io
Edge Impulse Health API
AE Profile APIs.io
#User
← Back to E APIs
API Details
ID
edge-impulse:edge-impulse-user-api
Base URL
https://studio.edgeimpulse.com/v1
Docs
https://docs.edgeimpulse.com/reference/edge-impulse-api
Provider
Edge Impulse
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network