Organization metrics

Get general metrics for this organization.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/metrics

Path parameters

organizationId*integer

Organization ID

Query parameters

excludeEdgeImpulseUsersboolean

Whether to exclude Edge Impulse users when counting enterprise entitlements usage

projectVisibilityProjectVisibility (enum)

The visibility of the project, either public or private. Public projects can be viewed by anyone on the internet and edited by collaborators. Private projects can only be viewed and edited by collaborators.

publicprivate

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

metrics*object

totalJobsComputeTime*number

Total compute time of all organizational jobs since the creation of the organization (including organizational project jobs). Compute time is the amount of computation time spent in jobs, in minutes used by an organization over a 12 month period, calculated as CPU + GPU minutes.

jobsComputeTimeCurrentYear*number

Total compute time of all organizational jobs in the current contract (including organizational project jobs). Compute time is the amount of computation time spent in jobs, in minutes used by an organization over a 12 month period, calculated as CPU + GPU minutes.

jobsComputeTimeCurrentYearSince*string (date-time)

The date from which the compute time for the running contract is calculated.

cpuComputeTimeCurrentContract*number

CPU compute time of all jobs in the organization in the current contract (including organizational project jobs).

gpuComputeTimeCurrentContract*number

GPU compute time of all jobs in the organization in the current contract (including organizational project jobs).

totalStorage*number

Total storage used by the organization.

projectCount*integer

Total number of projects owned by the organization.

userCount*integer

Total number of users in the organization.

Request

Response

List active organizations

Retrieve list of organizations that a user is a part of. If authenticating using JWT token this lists all the organizations the user has access to, if authenticating using an API key, this only lists that organization.

GEThttps://studio.edgeimpulse.com/v1/api/organizations

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

organizations*array of Organization (object)

Array with organizations

id*integer

name*string

EdgeImpulse Inc.

logostring

Example: "https://usercdn.edgeimpulse.com/logos/1.jpg"

headerImgstring

Example: "https://usercdn.edgeimpulse.com/leaders/1.jpg"

showHeaderImgMask*boolean

users*array of OrganizationUser (all of)

id*integer

Example: 1

username*string

Example: "janjongboom"

name*string

Example: "Jan Jongboom"

email*string

Example: "quijote@edgeimpulse.com"

photostring

Example: "https://usercdn.edgeimpulse.com/photos/1.jpg"

created*string (date-time)

Example: "2019-08-31T17:32:28Z"

lastSeenstring (date-time)

Example: "2019-08-31T17:32:28Z"

staffInfo*StaffInfo (object)

isStaff*boolean

hasSudoRights*boolean

companyNamestring

pending*boolean

lastTosAcceptanceDatestring (date-time)

Example: "2019-08-31T17:32:28Z"

jobTitlestring

Example: "Software Engineer"

permissionsarray of Permission (enum)

List of permissions the user has

itemsPermission (enum)

admin:infra:disallowedEmailDomains:writeadmin:infra:featureFlags:readadmin:infra:featureFlags:writeadmin:infra:config:readadmin:infra:config:writeadmin:infra:migrations:readadmin:infra:migrations:writeadmin:metrics:readadmin:metrics:writeadmin:organizations:readadmin:organizations:writeadmin:organizations:members:writeadmin:projects:members:writeadmin:projects:readadmin:projects:writeadmin:trials:readadmin:trials:writeadmin:users:permissions:writeadmin:users:readadmin:users:writeadmin:jobs:readadmin:emails:verification:code:readprojects:limits:writeprojects:training:keras:writethirdpartyauth:readthirdpartyauth:writeusers:emails:readwhitelabels:readwhitelabels:write

companyNamestring

Example: "Edge Impulse Inc."

activated*boolean

Whether the user has activated their account or not.

mfaConfigured*boolean

Whether the user has configured multi-factor authentication

stripeCustomerIdstring

Stripe customer ID, if any.

hasPendingPaymentsboolean

Whether the user has pending payments.

tierUserTierEnum (enum)

The user account tier.

freecommunity-plusprofessionalenterprise

added*string (date-time)

Example: "2019-08-31T17:32:28Z"

role*OrganizationMemberRole (enum)

adminmemberguest

projectCount*integer

datasets*array of string

itemsstring

lastAccessToOrganizationstring (date-time)

Date when the user last accessed the organization data.

lastOrganizationProjectAccessedinteger

ID of the last project accessed by the user in the organization.

isDeveloperProfile*boolean

whitelabelId*nullable integer

Unique identifier of the white label this organization belongs to, if any.

projectsarray of Project (object)

id*integer

Example: 1

name*string

Example: "Water hammer detection"

description*string

created*string (date-time)

Example: "2019-07-21T17:32:28Z"

owner*string

User or organization that owns the project

lastAccessedstring (date-time)

Example: "2019-07-21T17:32:28Z"

lastModifiedstring (date-time)

Example: "2019-07-21T17:32:28Z"

lastModificationDetailsstring

Details about the last modification

Example: "Data sample added"

logostring

Custom logo for this project (not available for all projects)

ownerUserIdinteger

ownerOrganizationIdinteger

ownerAvatarstring

URL of the project owner avatar, if any.

ownerIsDeveloperProfile*boolean

developerProfileUserIdinteger

User ID of the developer profile, if any.

collaborators*array of ProjectCollaborator (all of)

id*integer

Example: 1

username*string

Example: "janjongboom"

name*string

Example: "Jan Jongboom"

email*string

Example: "quijote@edgeimpulse.com"

photostring

Example: "https://usercdn.edgeimpulse.com/photos/1.jpg"

created*string (date-time)

Example: "2019-08-31T17:32:28Z"

lastSeenstring (date-time)

Example: "2019-08-31T17:32:28Z"

staffInfo*StaffInfo (object)

isStaff*boolean

hasSudoRights*boolean

companyNamestring

pending*boolean

lastTosAcceptanceDatestring (date-time)

Example: "2019-08-31T17:32:28Z"

jobTitlestring

Example: "Software Engineer"

permissionsarray of Permission (enum)

List of permissions the user has

itemsPermission (enum)

companyNamestring

Example: "Edge Impulse Inc."

activated*boolean

Whether the user has activated their account or not.

mfaConfigured*boolean

Whether the user has configured multi-factor authentication

stripeCustomerIdstring

Stripe customer ID, if any.

hasPendingPaymentsboolean

Whether the user has pending payments.

tierUserTierEnum (enum)

The user account tier.

freecommunity-plusprofessionalenterprise

isOwner*boolean

labelingMethod*enum

single_labelobject_detection

metadata*object

Metadata about the project

dataExplorerScreenshotstring

isEnterpriseProject*boolean

Whether this is an enterprise project

whitelabelId*nullable integer

Unique identifier of the white label this project belongs to, if any.

tagsarray of string

List of project tags

itemsstring

categorystring

Project category

Example: "Image classification"

licensestring

Public project license, if any.

tier*ProjectTierEnum (enum)

The project tier. This is "enterprise" for all organization projects, or the user tier for all user projects.

freecommunity-plusprofessionalenterprise

hasPublicVersion*boolean

Whether this project has been published or not.

isPublic*boolean

Whether this is a public version of a project. A version is a snapshot of a project at a certain point in time, which can be used to periodically save the state of a project. Versions can be private (just for internal use and reference) or public, available to everyone. A public version can be cloned by anyone, restoring the state of the project at the time into a new, separate project.

allowsLivePublicAccess*boolean

Whether this project allows live, public access. Unlike a public version, a live public project is not fixed in time, and always includes the latest project changes. Similar to public versions, a live public project can be cloned by anyone, creating a new, separate project.

indPauseProcessingSamples*boolean

publicProjectListed*boolean

If the project allows public access, whether to list it the public projects overview response. If not listed, the project is still accessible via direct link. If the project does not allow public access, this field has no effect.

trialId*nullable integer

Unique identifier of the trial this organization belongs to, if any.

trialExpiredDate*nullable string (date-time)

Date when the trial expired, if any. A expired trial has a grace period of 30 days before it's associated organization is deleted.

trialUpgradedDate*nullable string (date-time)

Date when the trial was upgraded to a full enterprise account, if any.

created*string (date-time)

Date when the organization was created.

contractStartDatenullable string (date-time)

Date when the current contract started, if any.

deletedDatestring (date-time)

The date in which the organization was deleted. If the organization is not deleted, this field is not set.

Request

Response

Request trial extension

Request an extension for an enterprise trial.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/trial/request-extension

Path parameters

organizationId*integer

Organization ID

Body

reasonstring

Answer to the question: 'Why is this the right time for your team to invest in edge AI?'. This is optional.

useCasestring

Answer to the question: 'What best describes your use case?'. This is optional.

timelinestring

Answer to the question: 'What is your timeline for solving your problem?'. This is optional.

objectivestring

Answer to the question: 'What are you hoping to achieve with an extension?'. This is optional.

trialIdnumber

The user's trial ID. This is optional.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Get white label information

White label admin only API to get the white label information.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel

Path parameters

organizationId*integer

Organization ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

whitelabelWhitelabel (object)

id*integer

name*string

domain*string

ownerOrganizationIdinteger

themeId*integer

themeTheme (object)

id*integer

ownerUserIdinteger

ownerOrganizationIdinteger

name*string

favicon*object

favicon32string

favicon57string

favicon76string

favicon96string

favicon120string

favicon128string

favicon144string

favicon152string

favicon180string

favicon228string

logos*object

primarystring

primaryPngstring

primaryWhitestring

loginLogostring

loginLogoWhitestring

markstring

markWhitestring

deviceLogostring

colors*object

primaryColorstring

primaryColorRgbarray of number

itemsnumber

primaryColorGradientEndstring

identityProviders*array of string

itemsstring

allowPasswordAuth*boolean

deploymentTargets*array of string

List of deployment targets enabled for this white label

itemsstring

allDeploymentTargets*array of string

List of all supported deployment targets

itemsstring

customDeploymentBlocksarray of object

List of custom deployment blocks available to this white label

name*string

The name of the custom deployment block

id*number

The custom deployment block ID

deploymentOptionsOrderDeploymentOptionsOrder (array of string)

Optional attribute allowing a whitelabel to customize the order of deployment options in the deployment view, given as an in-order list of deployment options.

itemsstring

Deployment option name

Example: "org-1"

allowSignup*boolean

allowFreeProjects*boolean

exposePublicProjectsboolean

defaultDeploymentTargetnullable string

The name of the default deployment target for this white label

Example: "C++ Library"

supportedProjectTypes*array of ProjectType (enum)

itemsProjectType (enum)

kwsaudioobject-detectionimageaccelerometerother

allowNewProjectUi*boolean

Whether the new project UI should be enabled for this white label or not.

learningBlocks*array of string

List of learning blocks enabled for this white label

itemsstring

allLearningBlocks*array of object

List of all supported learning blocks

title*string

The name of the learning block

type*string

The learning block type

developmentBoards*array of DevelopmentBoardResponse (object)

id*integer

name*string

image*string

docsUrl*string

allDevelopmentBoards*array of DevelopmentBoardResponse (object)

id*integer

name*string

image*string

docsUrl*string

organizationsLimitinteger

The maximum number of organizations that can be created under this white label.

Request

Response

White Label Admin - Update white label information

White label admin only API to update the white label information.

PUThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel

Path parameters

organizationId*integer

Organization ID

Body

supportedProjectTypesarray of ProjectType (enum)

itemsProjectType (enum)

kwsaudioobject-detectionimageaccelerometerother

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

Update organization

Update organization properties such as name and logo.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}

Path parameters

organizationId*integer

Organization ID

Body

logostring

New logo URL, or set to null to remove the logo.

headerImgstring

New leader image URL, or set to null to remove the leader.

showHeaderImgMaskboolean

namestring

New organization name.

experimentsarray of string

itemsstring

readmestring

Readme for the organization (in Markdown)

jobLimitMinteger

New job limit in seconds.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Update deployment targets

White label admin only API to update some or all of the deployment targets enabled for this white label.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/deploymentTargets

Path parameters

organizationId*integer

Organization ID

Body

targetsarray of string

The names of the deployment targets that are enabled for this whitelabel.

itemsstring

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

Organization information

White Label Admin - Update learning blocks

White Label Admin - Update theme logo

Organization information

List all information about this organization.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}

Path parameters

organizationId*integer

Organization ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

organization*Organization (object)

id*integer

name*string

EdgeImpulse Inc.

logostring

Example: "https://usercdn.edgeimpulse.com/logos/1.jpg"

headerImgstring

Example: "https://usercdn.edgeimpulse.com/leaders/1.jpg"

showHeaderImgMask*boolean

users*array of OrganizationUser (all of)

id*integer

Example: 1

username*string

Example: "janjongboom"

name*string

Example: "Jan Jongboom"

email*string

Example: "quijote@edgeimpulse.com"

photostring

Example: "https://usercdn.edgeimpulse.com/photos/1.jpg"

created*string (date-time)

Example: "2019-08-31T17:32:28Z"

lastSeenstring (date-time)

Example: "2019-08-31T17:32:28Z"

staffInfo*StaffInfo (object)

isStaff*boolean

hasSudoRights*boolean

companyNamestring

pending*boolean

lastTosAcceptanceDatestring (date-time)

Example: "2019-08-31T17:32:28Z"

jobTitlestring

Example: "Software Engineer"

permissionsarray of Permission (enum)

List of permissions the user has

itemsPermission (enum)

companyNamestring

Example: "Edge Impulse Inc."

activated*boolean

Whether the user has activated their account or not.

mfaConfigured*boolean

Whether the user has configured multi-factor authentication

stripeCustomerIdstring

Stripe customer ID, if any.

hasPendingPaymentsboolean

Whether the user has pending payments.

tierUserTierEnum (enum)

The user account tier.

freecommunity-plusprofessionalenterprise

added*string (date-time)

Example: "2019-08-31T17:32:28Z"

role*OrganizationMemberRole (enum)

adminmemberguest

projectCount*integer

datasets*array of string

itemsstring

lastAccessToOrganizationstring (date-time)

Date when the user last accessed the organization data.

lastOrganizationProjectAccessedinteger

ID of the last project accessed by the user in the organization.

isDeveloperProfile*boolean

whitelabelId*nullable integer

Unique identifier of the white label this organization belongs to, if any.

projectsarray of Project (object)

id*integer

Example: 1

name*string

Example: "Water hammer detection"

description*string

created*string (date-time)

Example: "2019-07-21T17:32:28Z"

owner*string

User or organization that owns the project

lastAccessedstring (date-time)

Example: "2019-07-21T17:32:28Z"

lastModifiedstring (date-time)

Example: "2019-07-21T17:32:28Z"

lastModificationDetailsstring

Details about the last modification

Example: "Data sample added"

logostring

Custom logo for this project (not available for all projects)

ownerUserIdinteger

ownerOrganizationIdinteger

ownerAvatarstring

URL of the project owner avatar, if any.

ownerIsDeveloperProfile*boolean

developerProfileUserIdinteger

User ID of the developer profile, if any.

collaborators*array of ProjectCollaborator (all of)

id*integer

Example: 1

username*string

Example: "janjongboom"

name*string

Example: "Jan Jongboom"

email*string

Example: "quijote@edgeimpulse.com"

photostring

Example: "https://usercdn.edgeimpulse.com/photos/1.jpg"

created*string (date-time)

Example: "2019-08-31T17:32:28Z"

lastSeenstring (date-time)

Example: "2019-08-31T17:32:28Z"

staffInfo*StaffInfo (object)

isStaff*boolean

hasSudoRights*boolean

companyNamestring

pending*boolean

lastTosAcceptanceDatestring (date-time)

Example: "2019-08-31T17:32:28Z"

jobTitlestring

Example: "Software Engineer"

permissionsarray of Permission (enum)

List of permissions the user has

itemsPermission (enum)

companyNamestring

Example: "Edge Impulse Inc."

activated*boolean

Whether the user has activated their account or not.

mfaConfigured*boolean

Whether the user has configured multi-factor authentication

stripeCustomerIdstring

Stripe customer ID, if any.

hasPendingPaymentsboolean

Whether the user has pending payments.

tierUserTierEnum (enum)

The user account tier.

freecommunity-plusprofessionalenterprise

isOwner*boolean

labelingMethod*enum

single_labelobject_detection

metadata*object

Metadata about the project

dataExplorerScreenshotstring

isEnterpriseProject*boolean

Whether this is an enterprise project

whitelabelId*nullable integer

Unique identifier of the white label this project belongs to, if any.

tagsarray of string

List of project tags

itemsstring

categorystring

Project category

Example: "Image classification"

licensestring

Public project license, if any.

tier*ProjectTierEnum (enum)

The project tier. This is "enterprise" for all organization projects, or the user tier for all user projects.

freecommunity-plusprofessionalenterprise

hasPublicVersion*boolean

Whether this project has been published or not.

isPublic*boolean

allowsLivePublicAccess*boolean

indPauseProcessingSamples*boolean

publicProjectListed*boolean

trialId*nullable integer

Unique identifier of the trial this organization belongs to, if any.

trialExpiredDate*nullable string (date-time)

Date when the trial expired, if any. A expired trial has a grace period of 30 days before it's associated organization is deleted.

trialUpgradedDate*nullable string (date-time)

Date when the trial was upgraded to a full enterprise account, if any.

created*string (date-time)

Date when the organization was created.

contractStartDatenullable string (date-time)

Date when the current contract started, if any.

deletedDatestring (date-time)

The date in which the organization was deleted. If the organization is not deleted, this field is not set.

datasets*array of OrganizationDataset (object)

dataset*string

lastFileCreated*string (date-time)

totalFileSize*integer

totalFileCount*integer

totalItemCount*integer

totalItemCountChecklistOK*integer

totalItemCountChecklistFailed*integer

tags*array of string

itemsstring

categorystring

bucketOrganizationDatasetBucket (object)

id*integer

Bucket ID

bucket*string

path*string

Path in the bucket

fullBucketPathDescription*string

Full bucket path, incl. protocol (e.g. s3://bucket/path) - to be used in the UI

dataItemNamingLevelsDeep*integer

Number of levels deep for data items, e.g. if you have folder "test/abc", with value 1 "test" will be a data item, with value 2 "test/abc" will be a data item. Only used for "clinical" type.

type*OrganizationDatasetTypeEnum (enum)

clinicalfiles

bucketPathstring

Location of the dataset within the bucket

defaultComputeLimits*object

requestsCpu*number

requestsMemory*number

limitsCpu*number

limitsMemory*number

entitlementLimitsEntitlementLimits (object)

totalStoragenumber

Storage entitlement, in bytes

computeTimePerYearnumber

Total compute time entitlement (CPU + GPU), in seconds

gpuComputeTimePerYearnumber

GPU compute time entitlement, in seconds

numberOfProjectsinteger

Number of projects allowed for this organization

numberOfUsersinteger

Number of users allowed for this organization

experiments*array of object

Experiments that the organization has access to. Enabling experiments can only be done through a JWT token.

type*string

title*string

helpstring

enabled*boolean

showToUser*boolean

readmeobject

Present if a readme is set for this project

markdown*string

html*string

whitelabelIdinteger

cliLists*object

objectDetectionLastLayerOptions*array of object

label*string

value*ObjectDetectionLastLayer (enum)

mobilenet-ssdfomoyolov2-akidayolov5yolov5v5-drpaiyoloxyolov7tao-retinanettao-ssdtao-yolov3tao-yolov4

imageInputScalingOptions*array of object

label*string

value*ImageInputScaling (enum)

Normalization that is applied to images. If this is not set then 0..1 is used. "0..1" gives you non-normalized pixels between 0 and 1. "-1..1" gives you non-normalized pixels between -1 and 1. "0..255" gives you non-normalized pixels between 0 and 255. "-128..127" gives you non-normalized pixels between -128 and 127. "torch" first scales pixels between 0 and 1, then applies normalization using the ImageNet dataset (same as torchvision.transforms.Normalize()). "bgr-subtract-imagenet-mean" scales to 0..255, reorders pixels to BGR, and subtracts the ImageNet mean from each channel.

0..1-1..1-128..1270..255torchbgr-subtract-imagenet-mean

performance*object

jobLimitM*integer

Compute time limit per job in minutes (for non-transformation jobs).

Request

Response

White Label Admin - Update learning blocks

White label admin only API to update some or all of the learning blocks enabled for this white label.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/learningBlocks

Path parameters

organizationId*integer

Organization ID

Body

learningBlocksarray of string

The types of the learning blocks that are enabled for this whitelabel.

itemsstring

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Update theme logo

White label admin only API to update the white label theme logo.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/theme/logo

Path parameters

organizationId*integer

Organization ID

Body

imagestring (binary)

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

urlstring

Request

Response

Remove organization

Remove the current organization, and all data associated with it. This is irrevocable!

DELETEhttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}

Path parameters

organizationId*integer

Organization ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Update theme favicon

White label admin only API to update the theme favicon.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/theme/favicon

Path parameters

organizationId*integer

Organization ID

Body

image*string (binary)

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Update theme device logo

White label admin only API to update the white label theme device logo.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/theme/deviceLogo

Path parameters

organizationId*integer

Organization ID

Body

imagestring (binary)

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

urlstring

Request

Response

White Label Admin - Get global white label metrics

White label admin only API to get global metrics.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/metrics

Path parameters

organizationId*integer

Organization ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

metrics*object

Request

Response

White Label Admin - Get a white label user

White label admin only API to get information about a user.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/users/{userId}

Path parameters

organizationId*integer

Organization ID

userId*integer

User ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

user*AdminApiUser (all of)

id*integer

Example: 1

username*string

Example: "janjongboom"

name*string

Example: "Jan Jongboom"

email*string

Example: "quijote@edgeimpulse.com"

photostring

Example: "https://usercdn.edgeimpulse.com/photos/1.jpg"

created*string (date-time)

Example: "2019-08-31T17:32:28Z"

lastSeenstring (date-time)

Example: "2019-08-31T17:32:28Z"

staffInfo*StaffInfo (object)

isStaff*boolean

hasSudoRights*boolean

companyNamestring

pending*boolean

lastTosAcceptanceDatestring (date-time)

Example: "2019-08-31T17:32:28Z"

jobTitlestring

Example: "Software Engineer"

permissionsarray of Permission (enum)

List of permissions the user has

itemsPermission (enum)

companyNamestring

Example: "Edge Impulse Inc."

activated*boolean

Whether the user has activated their account or not.

mfaConfigured*boolean

Whether the user has configured multi-factor authentication

stripeCustomerIdstring

Stripe customer ID, if any.

hasPendingPaymentsboolean

Whether the user has pending payments.

tierUserTierEnum (enum)

The user account tier.

freecommunity-plusprofessionalenterprise

email*string

activated*boolean

organizations*array of UserOrganization (object)

Organizations that the user is a member of. Only filled when requesting information about yourself.

id*integer

name*string

logostring

isDeveloperProfile*boolean

whitelabelId*nullable integer

Unique identifier of the white label this project belongs to, if any.

isAdmin*boolean

Whether the user is admin of this organization or not.

created*string (date-time)

When the organization was created.

Example: "2019-08-31T17:32:28Z"

trialId*nullable number

Unique identifier of the trial this organization belongs to, if any.

Example: 1

trialExpiredDate*nullable string (date-time)

Date when the trial expired, if any. A expired trial has a grace period of 30 days before it's associated organization is deleted.

Example: "2019-08-31T17:32:28Z"

trialUpgradedDate*nullable string (date-time)

Date when the trial was upgraded to a full enterprise account, if any.

Example: "2019-08-31T17:32:28Z"

entitlementLimits*EntitlementLimits (object)

totalStoragenumber

Storage entitlement, in bytes

computeTimePerYearnumber

Total compute time entitlement (CPU + GPU), in seconds

gpuComputeTimePerYearnumber

GPU compute time entitlement, in seconds

numberOfProjectsinteger

Number of projects allowed for this organization

numberOfUsersinteger

Number of users allowed for this organization

userCount*integer

The total number of users that are a member of this organization.

adminCount*integer

The number of admin users for this organization.

privateProjectCount*integer

The number of private projects for this organization.

lastAccessedstring (date-time)

Last time this user accessed this organization.

projects*array of Project (object)

id*integer

Example: 1

name*string

Example: "Water hammer detection"

description*string

created*string (date-time)

Example: "2019-07-21T17:32:28Z"

owner*string

User or organization that owns the project

lastAccessedstring (date-time)

Example: "2019-07-21T17:32:28Z"

lastModifiedstring (date-time)

Example: "2019-07-21T17:32:28Z"

lastModificationDetailsstring

Details about the last modification

Example: "Data sample added"

logostring

Custom logo for this project (not available for all projects)

ownerUserIdinteger

ownerOrganizationIdinteger

ownerAvatarstring

URL of the project owner avatar, if any.

ownerIsDeveloperProfile*boolean

developerProfileUserIdinteger

User ID of the developer profile, if any.

collaborators*array of ProjectCollaborator (all of)

id*integer

Example: 1

username*string

Example: "janjongboom"

name*string

Example: "Jan Jongboom"

email*string

Example: "quijote@edgeimpulse.com"

photostring

Example: "https://usercdn.edgeimpulse.com/photos/1.jpg"

created*string (date-time)

Example: "2019-08-31T17:32:28Z"

lastSeenstring (date-time)

Example: "2019-08-31T17:32:28Z"

staffInfo*StaffInfo (object)

isStaff*boolean

hasSudoRights*boolean

companyNamestring

pending*boolean

lastTosAcceptanceDatestring (date-time)

Example: "2019-08-31T17:32:28Z"

jobTitlestring

Example: "Software Engineer"

permissionsarray of Permission (enum)

List of permissions the user has

itemsPermission (enum)

companyNamestring

Example: "Edge Impulse Inc."

activated*boolean

Whether the user has activated their account or not.

mfaConfigured*boolean

Whether the user has configured multi-factor authentication

stripeCustomerIdstring

Stripe customer ID, if any.

hasPendingPaymentsboolean

Whether the user has pending payments.

tierUserTierEnum (enum)

The user account tier.

freecommunity-plusprofessionalenterprise

isOwner*boolean

labelingMethod*enum

single_labelobject_detection

metadata*object

Metadata about the project

dataExplorerScreenshotstring

isEnterpriseProject*boolean

Whether this is an enterprise project

whitelabelId*nullable integer

Unique identifier of the white label this project belongs to, if any.

tagsarray of string

List of project tags

itemsstring

categorystring

Project category

Example: "Image classification"

licensestring

Public project license, if any.

tier*ProjectTierEnum (enum)

The project tier. This is "enterprise" for all organization projects, or the user tier for all user projects.

freecommunity-plusprofessionalenterprise

hasPublicVersion*boolean

Whether this project has been published or not.

isPublic*boolean

allowsLivePublicAccess*boolean

indPauseProcessingSamples*boolean

publicProjectListed*boolean

experiments*array of UserExperiment (object)

Experiments the user has access to. Enabling experiments can only be done through a JWT token.

type*string

title*string

helpstring

enabled*boolean

showToUser*boolean

evaluationboolean

Whether this is an ephemeral evaluation account.

ambassadorboolean

Whether this user is an ambassador.

tier*UserTierEnum (enum)

The user account tier.

freecommunity-plusprofessionalenterprise

lastSeenstring (date-time)

suspended*boolean

Whether the user is suspended.

trials*array of EnterpriseTrial (object)

Current or past enterprise trials.

id*integer

Unique identifier of the trial.

userId*integer

ID of the user who created the trial.

organizationId*integer

ID of the organization created for the trial.

created*string (date-time)

Date when the trial was created. Trials start immediately on creation.

expirationDate*TrialExpirationDate (string (date-time))

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 deleting the trial organization. This field is ignored if the trial is requested by a non-admin user, defaulting to 14 days trial.

Example: "2020-01-01T00:00:00Z"

notesTrialNotes (string)

Notes about the trial. Free form text. This field is ignored if the trial is requested by a non-admin user.

Example: "This is a trial for the company's new project."

expiredDate*nullable string (date-time)

Date when the trial actually expired. This is set when the trial is expired by the system.

deletedDate*nullable string (date-time)

Date when the trial was deleted. This is set when the trial is fully deleted by the system.

upgradedDate*nullable string (date-time)

Date when the trial was upgraded to a full enterprise account.

dailyMetricsnullable array of DailyMetricsRecord (object)

Metrics for the last 365 days

date*string (date-time)

Date of the metrics record.

Example: "2021-01-01T00:00:00Z"

totalUsers*integer

Total number of users, if the metrics record applies to a non-developer profile organization. For developer profile organizations, we default to 0.

Example: 100

totalStaffUsers*integer

Total number of staff users, if the metrics record applies to a non-developer profile organization. For developer profile organizations, we default to 0.

Example: 10

totalProjects*integer

Total number of projects at the end of the metrics record date.

Example: 50

totalCurrentContractCpuComputeTimeSeconds*integer

Total CPU compute time since contract start date, or organization / user creation date, at the end of the metrics record date.

Example: 100000

totalCurrentContractGpuComputeTimeSeconds*integer

Total GPU compute time since contract start date, or organization / user creation date, at the end of the metrics record date.

Example: 100000

totalCurrentContractComputeTimeSeconds*integer

Total compute time since contract start date, or organization / user creation date, at the end of the metrics record date. Compute time is calculated as CPU + 3*GPU compute time.

Example: 100000

computeTimeCalculatedSince*string (date-time)

Date from which the total compute time is calculated. This is the contract start date for billing organizations, or organization / user creation date.

Example: "2021-01-01T00:00:00Z"

totalStorageSizeBytes*integer

Total storage size in bytes at the end of the metrics record date.

Example: 1000000000

usersAdded*integer

Number of users added during the metrics record date.

Example: 10

staffUsersAddedinteger

Number of staff users added during the metrics record date.

Example: 1

usersDeleted*integer

Number of users deleted during the metrics record date.

Example: 5

staffUsersDeletedinteger

Number of staff users deleted during the metrics record date.

Example: 1

projectsAdded*integer

Number of projects added during the metrics record date.

Example: 10

projectsDeleted*integer

Number of projects deleted during the metrics record date.

Example: 5

cpuComputeTimeSeconds*integer

Total CPU compute time during the metrics record date.

Example: 10000

gpuComputeTimeSeconds*integer

Total GPU compute time during the metrics record date.

Example: 10000

computeTimeSeconds*integer

Total compute time during the metrics record date. Compute time is calculated as CPU + 3*GPU compute time.

Example: 10000

storageBytesAdded*integer

Total storage size in bytes added during the metrics record date.

Example: 1000000000

storageBytesDeleted*integer

Total storage size in bytes deleted during the metrics record date.

Example: 500000000

Request

Response

Delete a user

White label admin only API to delete a user.

DELETEhttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/users/{userId}

Path parameters

organizationId*integer

Organization ID

userId*integer

User ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Get white label user metrics

White label admin only API to get marketing metrics about a user.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/users/{userId}/metrics

Path parameters

organizationId*integer

Organization ID

userId*integer

User ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

metrics*object

Request

Response

White Label Admin - Update white label user

White label admin only API to update user properties.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/users/{userId}

Path parameters

organizationId*integer

Organization ID

userId*integer

User ID

Body

emailstring

New email. This will also update the forum's email address but the user may need to logout/login back

Example: "quijote@lamancha.es"

namestring

New user full name

Example: "Don Quijote de la Mancha"

activatedboolean

Whether the user is active or not. Can only go from inactive to active.

Example: true

suspendedboolean

Whether the user is suspended or not.

Example: false

jobTitlestring

New user job title

Example: "Knight"

experimentsarray of string

List of user experiments

itemsstring

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Get all white label projects

White label admin only API to get the list of all projects.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/projects

Path parameters

organizationId*integer

Organization ID

Query parameters

activeinteger

Whether to search for entities (users, orgs) active in the last X days

sortstring

Comma separated list of fields to sort query by. Prefix with a minus (-) sign to indicate descending order. Default order is ascending

Example: "id,-name"

filtersstring

Comma separated list of filters to apply to the query. Filters should be in the format 'field:value'.

Example: "billable:true"

limitinteger

Maximum number of results

offsetinteger

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

searchstring

Search query

Example: "<id> <name>"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

total*integer

projects*array of AdminApiProject (object)

Array with projects

id*integer

Example: 1

name*string

Example: "Water hammer detection"

descriptionstring

createdstring (date-time)

Example: "2019-07-21T17:32:28Z"

owner*string

User or organization that owns the project

ownerUserIdinteger

ownerOrganizationIdinteger

lastAccessedstring (date-time)

Example: "2019-07-21T17:32:28Z"

whitelabelIdnullable integer

Unique identifier of the white label this project belongs to, if any.

tierProjectTierEnum (enum)

The project tier. This is "enterprise" for all organization projects, or the user tier for all user projects.

freecommunity-plusprofessionalenterprise

Request

Response

White Label Admin - Get user jobs

White label admin only API to get the list of all project jobs for a user.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/users/{userId}/jobs

Path parameters

organizationId*integer

Organization ID

userId*integer

User ID

Query parameters

limitinteger

Maximum number of results

offsetinteger

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

jobs*array of Job (object)

Active jobs

id*integer

Job id, use this to refer back to the job. The web socket API also uses this ID.

category*string

key*string

External job identifier, this can be used to categorize jobs, and recover job status. E.g. set this to 'keras-192' for a Keras learning block with ID 192. When a user refreshes the page you can check whether a job is active for this ID and re-attach.

created*string (date-time)

When the job was created.

startedstring (date-time)

When the job was started.

finishedstring (date-time)

When the job was finished.

finishedSuccessfulboolean

Whether the job finished successfully.

jobNotificationUids*array of integer

The IDs of users who should be notified when a job is finished.

itemsinteger

additionalInfostring

Additional metadata associated with this job.

computeTimenumber

Job duration time in seconds from start to finished, measured by k8s job watcher.

createdByUserobject

id*integer

name*string

username*string

photostring

categoryCountinteger

Some job categories keep a counter on the job number, e.g. in synthetic data, so we know what the 1st, 2nd etc. job was in the UI.

totalJobCount*integer

Request

Response

White Label Admin - Get all white label users

White label admin only API to get the list of all registered users.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/users

Path parameters

organizationId*integer

Organization ID

Query parameters

activeinteger

Whether to search for entities (users, orgs) active in the last X days

tierUserTierEnum (enum)

The user account tier.

freecommunity-plusprofessionalenterprise

fieldsstring

Comma separated list of fields to fetch in a query

Example: "id,name"

sortstring

Comma separated list of fields to sort query by. Prefix with a minus (-) sign to indicate descending order. Default order is ascending

Example: "id,-name"

filtersstring

Comma separated list of filters to apply to the query. Filters should be in the format 'field:value'.

Example: "billable:true"

limitinteger

Maximum number of results

offsetinteger

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

searchstring

Search query

Example: "<id> <name>"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

total*integer

users*array of object

id*integer

Example: 1

username*string

Example: "janjongboom"

email*string

Example: "jan@edgeimpulse.com"

name*string

Example: "Jan Jongboom"

photostring

Example: "https://usercdn.edgeimpulse.com/photos/1.jpg"

created*string (date-time)

Example: "2019-08-31T17:32:28Z"

lastSeenstring (date-time)

Example: "2019-08-31T17:32:28Z"

activatedboolean

from_evaluationboolean

tierUserTierEnum (enum)

The user account tier.

freecommunity-plusprofessionalenterprise

Request

Response

White Label Admin - Update default deployment target

White label admin only API to update the default deployment target for this white label.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/deploymentTargets/default

Path parameters

organizationId*integer

Organization ID

Body

defaultDeploymentTarget*nullable string

Name of the default deployment target

Example: "C++ library"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Update the order of deployment options in the deployment view

White label admin only API to customize the order of deployment options in the deployment view for this white label.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/deploymentOptionsOrder

Path parameters

organizationId*integer

Organization ID

Body

orderDeploymentOptionsOrder (array of string)

Optional attribute allowing a whitelabel to customize the order of deployment options in the deployment view, given as an in-order list of deployment options.

itemsstring

Deployment option name

Example: "org-1"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Add Project API key

White label admin only API to add an API key to a project. Add a temporary API key that can be used to make Projects API (/api/projects/{projectId}/) requests on behalf of the project admin. These API keys are not visible to the project itself and have a customizable TTL defaulting to 1 minute.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/projects/{projectId}/apiKeys

Path parameters

organizationId*integer

Organization ID

projectId*integer

Project ID

Body

name*string

Description of the key

apiKey*string

API key. This needs to start with ei_ and will need to be at least 32 characters long.

ttlinteger

Time to live in seconds. If not set, the key will expire in 1 minute.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

Request HR block license

Request a license required for the deployment of an impulse containing the Edge Impulse HR block.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/request-hr-block-license

Path parameters

organizationId*integer

Organization ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Get project jobs

White label admin only API to get the list of all jobs for a project.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/projects/{projectId}/jobs

Path parameters

organizationId*integer

Organization ID

projectId*integer

Project ID

Query parameters

limitinteger

Maximum number of results

offsetinteger

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

jobs*array of Job (object)

Active jobs

id*integer

Job id, use this to refer back to the job. The web socket API also uses this ID.

category*string

key*string

created*string (date-time)

When the job was created.

startedstring (date-time)

When the job was started.

finishedstring (date-time)

When the job was finished.

finishedSuccessfulboolean

Whether the job finished successfully.

jobNotificationUids*array of integer

The IDs of users who should be notified when a job is finished.

itemsinteger

additionalInfostring

Additional metadata associated with this job.

computeTimenumber

Job duration time in seconds from start to finished, measured by k8s job watcher.

createdByUserobject

id*integer

name*string

username*string

photostring

categoryCountinteger

Some job categories keep a counter on the job number, e.g. in synthetic data, so we know what the 1st, 2nd etc. job was in the UI.

totalJobCount*integer

Request

Response

White Label Admin - Update theme colors

White label admin only API to update some or all theme colors.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/theme/colors

Path parameters

organizationId*integer

Organization ID

Body

primaryColorstring

Primary color in hex format

primaryColorGradientEndstring

Primary color gradient end in hex format

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Update white label project

White label admin only API to update project properties.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/projects/{projectId}

Path parameters

organizationId*integer

Organization ID

projectId*integer

Project ID

Body

logostring

New logo URL, or set to null to remove the logo.

namestring

New project name.

descriptionstring

projectVisibilityProjectVisibility (enum)

publicprivate

publicProjectListedboolean

lastDeployEonCompilerboolean

Call this when clicking the Eon compiler setting

lastDeployModelEngineModelEngineShortEnum (enum)

tflite-eontflite-eon-ram-optimizedtflite

latencyDevicestring

MCU used for calculating latency

experimentsarray of string

itemsstring

showCreateFirstImpulseboolean

Whether to show the 'Create your first impulse' section on the dashboard

labelingMethodenum

What labeling flow to use

single_labelobject_detection

selectedProjectTypeInWizardenum

Which option was selected in the project type wizard

accelerometeraudioimage_classificationobject_detectionsomething_else

gettingStartedStepinteger

The next step in the getting started wizard, or set to -1 to clear the getting started wizard

useGpuboolean

Whether to use GPU for training

computeTimeLimitMinteger

Job limit in minutes

dspFileSizeMbinteger

DSP file size in MB

enterprisePerformanceboolean

trainJobRamMbinteger

Amount of RAM allocated to training jobs

metadataobject

New metadata about the project

readmestring

Readme for the project (in Markdown)

lastAcquisitionLabelstring

trainJobNotificationUidsarray of integer

The IDs of users who should be notified when a Keras or retrain job is finished.

itemsinteger

dspJobNotificationUidsarray of integer

The IDs of users who should be notified when a DSP job is finished.

itemsinteger

modelTestingJobNotificationUidsarray of integer

The IDs of users who should be notified when a model testing job is finished.

itemsinteger

autoSegmenterJobNotificationUidsarray of integer

The IDs of users who should be notified when an auto segmentation job is finished.

itemsinteger

exportJobNotificationUidsarray of integer

The IDs of users who should be notified when an export job is finished.

itemsinteger

csvImportConfigobject

Config file specifying how to process CSV files. (set to null to clear the config)

inPretrainedModelFlowboolean

dspPageSizeinteger

Set to '0' to disable DSP paging

indPauseProcessingSamplesboolean

Used in tests, to ensure samples that need to be processed async are not picked up until the flag is set to FALSE again.

showSensorDataInAcquisitionGraphboolean

Whether to show the actual sensor data in acquisition charts (only applies when you have structured labels)

lastDeploymentTargetstring

Which deployment target was last selected (used to populate this deployment target again the next time you visit the deployment page). Should match the format property of the response from listDeploymentTargetsForProject.

dataAcquisitionPageSizeinteger

Default page size on data acquisition

dataAcquisitionViewTypeenum

Default view type on data acquisition

listgrid

dataAcquisitionGridColumnCountinteger

Number of grid columns in non-detailed view on data acquisition

dataAcquisitionGridColumnCountDetailedinteger

Number of grid columns in detailed view on data acquisition

showExactSampleLengthboolean

If enabled, does not round sample length to hours/minutes/seconds, but always displays sample length in milliseconds. E.g. instead of 1m 32s, this'll say 92,142ms.

inlineEditBoundingBoxesboolean

If enabled, allows editing bounding box labels directly from the acquisition UI.

defaultProfilingVariantKerasModelVariantEnum (enum)

int8float32akida

enabledModelProfilingVariantsarray of KerasModelVariantEnum (enum)

Set of model variants enabled by default on the model testing and live classification pages.

itemsKerasModelVariantEnum (enum)

int8float32akida

impulseListCoreMetricsHiddenColumnsarray of string

Which core metrics should be hidden in the impulse list. See 'GetAllDetailedImpulsesResponse' for a list of all metrics.

itemsstring

impulseListAdditionalMetricsShownColumnsarray of string

Which additional metrics should be shown in the impulse list. See 'GetAllDetailedImpulsesResponse' for a list of all metrics.

itemsstring

impulseListExtraColumnsarray of string

Which extra columns should be shown in the impulse list.

itemsstring

aiActionsGridColumnCountinteger

Number of grid columns in AI Actions

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Remove user from a project

White label admin only API to remove a user from a project.

DELETEhttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/projects/{projectId}/members/{userId}

Path parameters

organizationId*integer

Organization ID

projectId*integer

Project ID

userId*integer

User ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Get a white label project

White label admin only API to get project information.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/projects/{projectId}

Path parameters

organizationId*integer

Organization ID

projectId*integer

Project ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

project*Project (object)

id*integer

Example: 1

name*string

Example: "Water hammer detection"

description*string

created*string (date-time)

Example: "2019-07-21T17:32:28Z"

owner*string

User or organization that owns the project

lastAccessedstring (date-time)

Example: "2019-07-21T17:32:28Z"

lastModifiedstring (date-time)

Example: "2019-07-21T17:32:28Z"

lastModificationDetailsstring

Details about the last modification

Example: "Data sample added"

logostring

Custom logo for this project (not available for all projects)

ownerUserIdinteger

ownerOrganizationIdinteger

ownerAvatarstring

URL of the project owner avatar, if any.

ownerIsDeveloperProfile*boolean

developerProfileUserIdinteger

User ID of the developer profile, if any.

collaborators*array of ProjectCollaborator (all of)

id*integer

Example: 1

username*string

Example: "janjongboom"

name*string

Example: "Jan Jongboom"

email*string

Example: "quijote@edgeimpulse.com"

photostring

Example: "https://usercdn.edgeimpulse.com/photos/1.jpg"

created*string (date-time)

Example: "2019-08-31T17:32:28Z"

lastSeenstring (date-time)

Example: "2019-08-31T17:32:28Z"

staffInfo*StaffInfo (object)

isStaff*boolean

hasSudoRights*boolean

companyNamestring

pending*boolean

lastTosAcceptanceDatestring (date-time)

Example: "2019-08-31T17:32:28Z"

jobTitlestring

Example: "Software Engineer"

permissionsarray of Permission (enum)

List of permissions the user has

itemsPermission (enum)

companyNamestring

Example: "Edge Impulse Inc."

activated*boolean

Whether the user has activated their account or not.

mfaConfigured*boolean

Whether the user has configured multi-factor authentication

stripeCustomerIdstring

Stripe customer ID, if any.

hasPendingPaymentsboolean

Whether the user has pending payments.

tierUserTierEnum (enum)

The user account tier.

freecommunity-plusprofessionalenterprise

isOwner*boolean

labelingMethod*enum

single_labelobject_detection

metadata*object

Metadata about the project

dataExplorerScreenshotstring

isEnterpriseProject*boolean

Whether this is an enterprise project

whitelabelId*nullable integer

Unique identifier of the white label this project belongs to, if any.

tagsarray of string

List of project tags

itemsstring

categorystring

Project category

Example: "Image classification"

licensestring

Public project license, if any.

tier*ProjectTierEnum (enum)

The project tier. This is "enterprise" for all organization projects, or the user tier for all user projects.

freecommunity-plusprofessionalenterprise

hasPublicVersion*boolean

Whether this project has been published or not.

isPublic*boolean

allowsLivePublicAccess*boolean

indPauseProcessingSamples*boolean

publicProjectListed*boolean

developmentKeys*DevelopmentKeys (object)

apiKeystring

API Key

hmacKeystring

HMAC Key

impulse*object

created*boolean

Whether an impulse was created

configured*boolean

Whether an impulse was configured

complete*boolean

Whether an impulse was fully trained and configured

devices*array of Device (object)

id*integer

Example: 1

deviceId*string

Unique identifier (such as MAC address) for a device

Example: "38:f9:d3:d7:62:03"

created*string (date-time)

Example: "2019-07-21T17:32:28Z"

lastSeen*string (date-time)

Last message that was received from the device (ignoring keep-alive)

Example: "2019-08-31T17:32:28Z"

name*string

Example: "m6d.1 desk sensor"

deviceType*string

Example: "DISCO-L475VG"

sensors*array of object

name*string

Example: "Built-in accelerometer"

maxSampleLengthS*integer

Maximum supported sample length in seconds

frequencies*array of number

Supported frequencies for this sensor in Hz.

itemsnumber

remote_mgmt_connected*boolean

Whether the device is connected to the remote management interface. This property is deprecated, use remoteMgmtMode instead.

remote_mgmt_hoststring

The remote management host that the device is connected to

supportsSnapshotStreaming*boolean

remoteMgmtMode*enum

Replaces remote_mgmt_connected. Shows whether the device is connected to the remote management interface, and in which mode.

disconnectedingestioninference

inferenceInfoobject

If remoteMgmtMode is set to inference this object shows information about the model that's ran on device.

projectId*integer

projectOwner*string

projectName*string

deployedVersion*integer

modelTypeenum

classificationobjectDetectionconstrainedObjectDetection

dataSummary*ProjectDataSummary (object)

totalLengthMs*number

Total length (in ms.) of all data in the training set

Example: "726336"

labels*array of string

Labels in the training set

itemsstring

dataCount*integer

Example: "Number of files in the training set"

dataSummaryPerCategory*object

training*ProjectDataSummary (object)

totalLengthMs*number

Total length (in ms.) of all data in the training set

Example: "726336"

labels*array of string

Labels in the training set

itemsstring

dataCount*integer

Example: "Number of files in the training set"

testing*ProjectDataSummary (object)

totalLengthMs*number

Total length (in ms.) of all data in the training set

Example: "726336"

labels*array of string

Labels in the training set

itemsstring

dataCount*integer

Example: "Number of files in the training set"

anomaly*ProjectDataSummary (object)

totalLengthMs*number

Total length (in ms.) of all data in the training set

Example: "726336"

labels*array of string

Labels in the training set

itemsstring

dataCount*integer

Example: "Number of files in the training set"

computeTime*object

periodStartDate*string (date-time)

Start of the current time period.

periodEndDate*string (date-time)

End of the current time period. This is the date when the compute time resets again.

timeUsedMs*integer

The amount of compute used for the current time period.

timeLeftMs*integer

The amount of compute left for the current time period.

acquisitionSettings*object

intervalMs*number

Interval during the last acquisition, or the recommended interval based on the data set.

lengthMs*integer

Length of the last acquisition, or a recommended interval based on the data set.

sensorstring

Sensor that was used during the last acquisition.

labelstring

Label that was used during the last acquisition.

segmentLengthnumber

Length of the last sample segment after segmenting a larger sample.

segmentShift*boolean

Whether to auto-shift segments

defaultPageSize*integer

Default page size on data acquisition

viewType*enum

Default view type on data acquisition

listgrid

gridColumnCount*integer

Number of grid columns in non-detailed view

gridColumnCountDetailed*integer

Number of grid columns in detailed view

showExactSampleLength*boolean

If enabled, does not round sample length to hours/minutes/seconds, but always displays sample length in milliseconds. E.g. instead of 1m 32s, this'll say 92,142ms.

inlineEditBoundingBoxes*boolean

If enabled, allows editing bounding box labels directly from the acquisition UI.

collaborators*array of User (object)

id*integer

Example: 1

username*string

Example: "janjongboom"

name*string

Example: "Jan Jongboom"

email*string

Example: "quijote@edgeimpulse.com"

photostring

Example: "https://usercdn.edgeimpulse.com/photos/1.jpg"

created*string (date-time)

Example: "2019-08-31T17:32:28Z"

lastSeenstring (date-time)

Example: "2019-08-31T17:32:28Z"

staffInfo*StaffInfo (object)

isStaff*boolean

hasSudoRights*boolean

companyNamestring

pending*boolean

lastTosAcceptanceDatestring (date-time)

Example: "2019-08-31T17:32:28Z"

jobTitlestring

Example: "Software Engineer"

permissionsarray of Permission (enum)

List of permissions the user has

itemsPermission (enum)

companyNamestring

Example: "Edge Impulse Inc."

activated*boolean

Whether the user has activated their account or not.

mfaConfigured*boolean

Whether the user has configured multi-factor authentication

stripeCustomerIdstring

Stripe customer ID, if any.

hasPendingPaymentsboolean

Whether the user has pending payments.

tierUserTierEnum (enum)

The user account tier.

freecommunity-plusprofessionalenterprise

deploySettings*object

eonCompiler*boolean

sensor*enum

accelerometermicrophonecamerapositionalenvironmentalfusionunknown

arduinoLibraryName*string

tinkergenLibraryName*string

particleLibraryName*string

lastDeployModelEngineModelEngineShortEnum (enum)

tflite-eontflite-eon-ram-optimizedtflite

experiments*array of object

Experiments that the project has access to. Enabling experiments can only be done through a JWT token.

type*string

title*string

helpstring

enabled*boolean

showToUser*boolean

latencyDevices*array of LatencyDevice (object)

mcu*string

name*string

selected*boolean

int8Latency*number

int8ConvLatency*number

float32Latency*number

float32ConvLatency*number

helpText*string

urls*object

mobileClientstring

Base URL for the mobile client. If this is undefined then no development API key is set.

mobileClientComputerstring

Base URL for collecting data with the mobile client from a computer. If this is undefined then no development API key is set.

mobileClientInferencestring

Base URL for running inference with the mobile client. If this is undefined then no development API key is set.

showCreateFirstImpulse*boolean

showGettingStartedWizard*object

showWizard*boolean

step*integer

Current step of the getting started wizard

performance*object

gpu*boolean

jobLimitM*integer

Compute time limit per job in minutes (applies only to DSP and learning jobs).

dspFileSizeMb*integer

Maximum size for DSP file output

enterprisePerformance*boolean

trainJobRamMb*integer

Amount of RAM allocated to training jobs

readmeobject

Present if a readme is set for this project

markdown*string

html*string

trainJobNotificationUids*array of integer

The IDs of users who should be notified when a Keras or retrain job is finished.

itemsinteger

dspJobNotificationUids*array of integer

The IDs of users who should be notified when a DSP job is finished.

itemsinteger

modelTestingJobNotificationUids*array of integer

The IDs of users who should be notified when a model testing job is finished.

itemsinteger

autoSegmenterJobNotificationUids*array of integer

The IDs of users who should be notified when an auto segmentation job is finished.

itemsinteger

exportJobNotificationUids*array of integer

The IDs of users who should be notified when an export job is finished.

itemsinteger

hasNewTrainingData*boolean

csvImportConfigobject

Config file specifying how to process CSV files.

studioUrl*string

inPretrainedModelFlow*boolean

dspPageSizeinteger

showSensorDataInAcquisitionGraph*boolean

Whether to show the actual sensor data in acquisition charts (only applies when you have structured labels)

targetConstraintsTargetConstraints (object)

selectedTargetBasedOnenum

A type explaining how the target was chosen. If updating this manually, use the 'user-configured' type

user-configureddefaultdefault-acceptedrecent-projectconnected-device

targetDevices*array of TargetConstraintsDevice (object)

The potential targets for the project, where each entry captures hardware attributes that allow target guidance throughout the Studio workflow. The first target in the list is considered as the selected target for the project.

processorsarray of TargetProcessor (object)

Target processors

partstring

The exact part number, if available

formatstring

Processor type, serving as a broad descriptor for the intended use-case

Example: "low-end MCU"

architecturestring

Processor family, informing about the processor's instruction set and core design

Example: "Cortex-M"

specificArchitecturestring

Processor architecture, informing about the specific processor, if known

Example: "Cortex-M0+"

acceleratorstring

Target accelerator, if any

Example: "Arm Cortex-U55"

fpuboolean

Does the target processor have a floating point unit

clockRateMhzResourceRange (object)

Describes range of expected availability for an arbitrary resource

minimumnumber

maximumnumber

memoryTargetMemory (object)

RAM and ROM specifications of target

ramMemorySpec (object)

Describes performance characteristics of a particular memory type

fastBytesResourceRange (object)

Describes range of expected availability for an arbitrary resource

minimumnumber

maximumnumber

slowBytesResourceRange (object)

Describes range of expected availability for an arbitrary resource

minimumnumber

maximumnumber

romMemorySpec (object)

Describes performance characteristics of a particular memory type

fastBytesResourceRange (object)

Describes range of expected availability for an arbitrary resource

minimumnumber

maximumnumber

slowBytesResourceRange (object)

Describes range of expected availability for an arbitrary resource

minimumnumber

maximumnumber

boardstring

The exact dev board part number, if available

namestring

Display name in Studio

latencyDevicestring

MCU identifier, if available

Example: "cortex-m4f-80mhz"

applicationBudgets*array of ApplicationBudget (object)

A list of application budgets to be configured based on target device. An application budget enables guidance on performance and resource usage. The first application budget in the list is considered as the selected budget for the project.

latencyPerInferenceMsResourceRange (object)

Describes range of expected availability for an arbitrary resource

minimumnumber

maximumnumber

energyPerInferenceJoulesResourceRange (object)

Describes range of expected availability for an arbitrary resource

minimumnumber

maximumnumber

memoryOverheadTargetMemory (object)

RAM and ROM specifications of target

ramMemorySpec (object)

Describes performance characteristics of a particular memory type

fastBytesResourceRange (object)

Describes range of expected availability for an arbitrary resource

minimumnumber

maximumnumber

slowBytesResourceRange (object)

Describes range of expected availability for an arbitrary resource

minimumnumber

maximumnumber

romMemorySpec (object)

Describes performance characteristics of a particular memory type

fastBytesResourceRange (object)

Describes range of expected availability for an arbitrary resource

minimumnumber

maximumnumber

slowBytesResourceRange (object)

Describes range of expected availability for an arbitrary resource

minimumnumber

maximumnumber

notifications*array of string

List of notifications to show within the project

itemsstring

defaultImpulseIdinteger

Default selected impulse (by ID).

Request

Response

White Label Admin - Update a development board in a whitelabel

White label admin only API to update a development board.

PUThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/development-boards/{developmentBoardId}

Path parameters

organizationId*integer

Organization ID

developmentBoardId*integer

Development board ID.

Body

namestring

imagestring

docsUrlstring

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Create a new project within white label context.

Create a new free tier project. This is an API only available to white label admins.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/projects

Path parameters

organizationId*integer

Organization ID

Body

projectName*string

The name of the project.

Example: "My project"

projectVisibilityProjectVisibility (enum)

publicprivate

ownerIdinteger

Unique identifier of the owner of the new project. Either this parameter or ownerEmail must be set.

Example: 1

ownerEmailstring

Email of the owner of the new project. Either this parameter or ownerId must be set.

Example: "groucho@marxbros.com"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

id*integer

Project ID for the new project

apiKey*string

API key for the new project

Request

Response

White Label Admin - Update the image of a whitelabel development board

White label admin only API to update the image of a development board.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/development-boards/{developmentBoardId}/image

Path parameters

organizationId*integer

Organization ID

developmentBoardId*integer

Development board ID.

Body

imagestring (binary)

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

urlstring

Request

Response

White Label Admin - Delete a project

White label admin only API to delete a project.

DELETEhttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/projects/{projectId}

Path parameters

organizationId*integer

Organization ID

projectId*integer

Project ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Add user to a project

White label admin only API to add a user to a project. If no user is provided, the current user is used.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/projects/{projectId}/members

Path parameters

organizationId*integer

Organization ID

projectId*integer

Project ID

Body

usernameOrEmailstring

Username or email of the user to be added to the project or organization. If no user is provided, the user ID attached to the JWT will be used.

Example: "janjongboom"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Create new organization within white label context

Create a new organization. This is an API only available to white label admins

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations

Path parameters

organizationId*integer

Organization ID

Body

organizationName*string

The name of the organization.

Example: "EdgeImpulse Inc."

adminIdinteger

Unique identifier of the administrator of the new organization.

Example: 1

adminEmailstring

Email of the administrator of the new organization.

Example: "jan@edgeimpulse.com"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

id*integer

Organization ID for the new organization

apiKey*string

API key for the new organization (this is shown only once)

Request

Response

White Label Admin - Add a development board to a whitelabel

White label admin only API to add a development board.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/development-boards

Path parameters

organizationId*integer

Organization ID

Body

name*string

image*string

docsUrl*string

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

id*integer

Request

Response

White Label Admin - Remove a development board from a whitelabel

White label admin only API to remove a development board.

DELETEhttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/development-boards/{developmentBoardId}

Path parameters

organizationId*integer

Organization ID

developmentBoardId*integer

Development board ID.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Get all usage reports

Get all usage reports for an organization. This is an API only available to white label admins.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/usage/reports

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

Query parameters

limitinteger

Maximum number of results

offsetinteger

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

reports*array of Report (object)

List of organization usage reports.

id*integer

created*string (date-time)

createdByUserobject

id*integer

name*string

username*string

photostring

jobId*integer

jobFinished*boolean

jobFinishedSuccessful*boolean

downloadLinkstring

reportStartDate*string (date-time)

reportEndDate*string (date-time)

totalCount*integer

Request

Response

White Label Admin - Delete usage report

Delete a usage report for an organization. This is an API only available to white label admins.

DELETEhttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/usage/reports/{reportId}

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

reportId*integer

Report ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Get all organizations within a white label

White label admin only API to get the list of all organizations.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations

Path parameters

organizationId*integer

Organization ID

Query parameters

activeinteger

Whether to search for entities (users, orgs) active in the last X days

includeDeletedboolean

Whether to include deleted entities (users, projects, orgs)

sortstring

Comma separated list of fields to sort query by. Prefix with a minus (-) sign to indicate descending order. Default order is ascending

Example: "id,-name"

filtersstring

Comma separated list of filters to apply to the query. Filters should be in the format 'field:value'.

Example: "billable:true"

limitinteger

Maximum number of results

offsetinteger

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

searchstring

Search query

Example: "<id> <name>"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

total*integer

organizations*array of object

Array with organizations

id*integer

Example: 1

name*string

Example: "Edge Impulse Inc."

logostring

created*string (date-time)

Example: "2019-08-31T17:32:28Z"

readmestring

experimentsarray of string

itemsstring

domainstring

whitelabelIdinteger

billableboolean

privateProjectCount*integer

entitlementLimitsEntitlementLimits (object)

totalStoragenumber

Storage entitlement, in bytes

computeTimePerYearnumber

Total compute time entitlement (CPU + GPU), in seconds

gpuComputeTimePerYearnumber

GPU compute time entitlement, in seconds

numberOfProjectsinteger

Number of projects allowed for this organization

numberOfUsersinteger

Number of users allowed for this organization

Request

Response

White Label Admin - Get organization compute time usage

Get compute time usage for an organization over a period of time. This is an API only available to white label admins

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/usage/computeTime

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

Query parameters

startDate*string (date-time)

Start date

endDate*string (date-time)

End date

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

cpuComputeTimenumber

CPU compute time in seconds of all jobs in the organization (including organizational project jobs).

gpuComputeTimenumber

GPU compute time in seconds of all jobs in the organization (including organizational project jobs).

totalComputeTimenumber

Total compute time is the amount of computation time spent in jobs, in minutes used by an organization over the given period, calculated as CPU + GPU minutes.

Request

Response

White Label Admin - Creates a new usage report

Create a new usage report for an organization. A job is created to process the report request and the job details are returned in the response. This is an API only available to white label admins.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/usage/reports

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

Query parameters

startDate*string (date-time)

Start date

endDate*string (date-time)

End date

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

id*integer

Job identifier. Status updates will include this identifier.

Example: 12873488112

Request

Response

White Label Admin - Get usage report

Get a usage report for an organization. This is an API only available to white label admins.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/usage/reports/{reportId}

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

reportId*integer

Report ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

report*Report (object)

id*integer

created*string (date-time)

createdByUserobject

id*integer

name*string

username*string

photostring

jobId*integer

jobFinished*boolean

jobFinishedSuccessful*boolean

downloadLinkstring

reportStartDate*string (date-time)

reportEndDate*string (date-time)

Request

Response

White Label Admin - Download usage report

Download a usage report for an organization. This is an API only available to white label admins.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/usage/reports/{reportId}/download

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

reportId*integer

Report ID

Response

A redirect to the CSV file

Request

White Label Admin - Get all organization data exports

Get all data exports for an organization. This is an API only available to white label admins.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/exports

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

Query parameters

limitinteger

Maximum number of results

offsetinteger

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

exports*array of OrganizationDataExport (object)

List of organization data exports.

id*integer

created*string (date-time)

createdByUserobject

id*integer

name*string

username*string

photostring

jobId*integer

jobFinished*boolean

jobFinishedSuccessful*boolean

descriptionstring

Description of the data export

expirationDate*string (date-time)

Date when the export will expire. Default is 30 days. Maximum expiration date is 60 days from the creation date.

downloadUrlstring

totalCount*integer

Request

Response

White Label Admin - Delete organization data export

Delete a data export for an organization. This is an API only available to white label admins.

DELETEhttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/exports/{exportId}

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

exportId*integer

Export ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Get organization data export

Get a data export for an organization. This is an API only available to white label admins.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/exports/{exportId}

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

exportId*integer

Export ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

export*OrganizationDataExport (object)

id*integer

created*string (date-time)

createdByUserobject

id*integer

name*string

username*string

photostring

jobId*integer

jobFinished*boolean

jobFinishedSuccessful*boolean

descriptionstring

Description of the data export

expirationDate*string (date-time)

Date when the export will expire. Default is 30 days. Maximum expiration date is 60 days from the creation date.

downloadUrlstring

Request

Response

White Label Admin - Create a new organization data export

Create a new data export for an organization. A job is created to process the export request and the job details are returned in the response. This is an API only available to white label admins.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/exports

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

Body

description*string

Description of the data export

expirationDatestring (date-time)

Date when the export will expire. Default is 30 days. Maximum expiration date is 60 days from the creation date.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

id*integer

Job identifier. Status updates will include this identifier.

Example: 12873488112

Request

Response

White Label Admin - Update organization data export

Update a data export for an organization. This is an API only available to white label admins.

PUThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/exports/{exportId}

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

exportId*integer

Export ID

Body

descriptionstring

Description of the data export

expirationDatestring (date-time)

Date when the export will expire. Default is 30 days. Maximum expiration date is 60 days from the creation date.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Add organization API key

White label admin only API to add an API key to an organization. Add a temporary API key that can be used to make Organizations API (/api/organizations/{organizationId}/) requests on behalf of the organization. These API keys are not visible to the organization itself and have a customizable TTL defaulting to 1 minute.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/apiKeys

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

Body

name*string

Description of the key

apiKey*string

API key. This needs to start with ei_ and will need to be at least 32 characters long.

role*enum

adminmember

ttlinteger

Time to live in seconds. If not set, the key will expire in 1 minute.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Remove user from an organization

White label admin only API to remove a user from an organization.

DELETEhttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/members/{userId}

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

userId*integer

User ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Add user to an organization

White label admin only API to add a user to an organization. If no user is provided, the current user is used.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/members

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

Body

usernameOrEmailstring

Username or email of the user to be added to the project or organization. If no user is provided, the user ID attached to the JWT will be used.

Example: "janjongboom"

role*OrganizationMemberRole (enum)

adminmemberguest

datasets*array of string

Only used for 'guest' users. Limits the datasets the user has access to.

itemsstring

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Delete an organization

White label admin only API to delete an organization.

DELETEhttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Create a new organization project

White label admin only API to create a new project for an organization.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/projects

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

Body

projectName*string

The name of the project.

Example: "My project"

projectVisibilityProjectVisibility (enum)

publicprivate

ownerIdinteger

Unique identifier of the owner of the new project. Either this parameter or ownerEmail must be set.

Example: 1

ownerEmailstring

Email of the owner of the new project. Either this parameter or ownerId must be set.

Example: "groucho@marxbros.com"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

id*integer

Project ID for the new project

apiKey*string

API key for the new project

Request

Response

White Label Admin - Get organization information

White label admin only API to list all information about an organization.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

Query parameters

includeDeletedboolean

Whether to include deleted entities (users, projects, orgs)

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

cpuComputeTimenumber

CPU compute time in seconds of all jobs in the organization (including organizational project jobs).

gpuComputeTimenumber

GPU compute time in seconds of all jobs in the organization (including organizational project jobs).

totalComputeTimenumber

Total compute time is the amount of computation time spent in jobs, in minutes used by an organization over the given period, calculated as CPU + GPU minutes.

billableboolean

entitlementLimitsEntitlementLimits (object)

totalStoragenumber

Storage entitlement, in bytes

computeTimePerYearnumber

Total compute time entitlement (CPU + GPU), in seconds

gpuComputeTimePerYearnumber

GPU compute time entitlement, in seconds

numberOfProjectsinteger

Number of projects allowed for this organization

numberOfUsersinteger

Number of users allowed for this organization

computeTimeCurrentContractSincestring (date-time)

The date from which the compute time for the running contract is calculated.

totalStoragenumber

Total storage used by the organization.

dailyMetricsnullable array of DailyMetricsRecord (object)

Metrics for the last 365 days

date*string (date-time)

Date of the metrics record.

Example: "2021-01-01T00:00:00Z"

totalUsers*integer

Total number of users, if the metrics record applies to a non-developer profile organization. For developer profile organizations, we default to 0.

Example: 100

totalStaffUsers*integer

Total number of staff users, if the metrics record applies to a non-developer profile organization. For developer profile organizations, we default to 0.

Example: 10

totalProjects*integer

Total number of projects at the end of the metrics record date.

Example: 50

totalCurrentContractCpuComputeTimeSeconds*integer

Total CPU compute time since contract start date, or organization / user creation date, at the end of the metrics record date.

Example: 100000

totalCurrentContractGpuComputeTimeSeconds*integer

Total GPU compute time since contract start date, or organization / user creation date, at the end of the metrics record date.

Example: 100000

totalCurrentContractComputeTimeSeconds*integer

Total compute time since contract start date, or organization / user creation date, at the end of the metrics record date. Compute time is calculated as CPU + 3*GPU compute time.

Example: 100000

computeTimeCalculatedSince*string (date-time)

Date from which the total compute time is calculated. This is the contract start date for billing organizations, or organization / user creation date.

Example: "2021-01-01T00:00:00Z"

totalStorageSizeBytes*integer

Total storage size in bytes at the end of the metrics record date.

Example: 1000000000

usersAdded*integer

Number of users added during the metrics record date.

Example: 10

staffUsersAddedinteger

Number of staff users added during the metrics record date.

Example: 1

usersDeleted*integer

Number of users deleted during the metrics record date.

Example: 5

staffUsersDeletedinteger

Number of staff users deleted during the metrics record date.

Example: 1

projectsAdded*integer

Number of projects added during the metrics record date.

Example: 10

projectsDeleted*integer

Number of projects deleted during the metrics record date.

Example: 5

cpuComputeTimeSeconds*integer

Total CPU compute time during the metrics record date.

Example: 10000

gpuComputeTimeSeconds*integer

Total GPU compute time during the metrics record date.

Example: 10000

computeTimeSeconds*integer

Total compute time during the metrics record date. Compute time is calculated as CPU + 3*GPU compute time.

Example: 10000

storageBytesAdded*integer

Total storage size in bytes added during the metrics record date.

Example: 1000000000

storageBytesDeleted*integer

Total storage size in bytes deleted during the metrics record date.

Example: 500000000

Request

Response

White Label Admin - Update organization

White label admin only API to update organization properties such as name and logo.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

Body

logostring

New logo URL, or set to null to remove the logo.

headerImgstring

New leader image URL, or set to null to remove the leader.

namestring

New organization name.

experimentsarray of string

itemsstring

readmestring

Readme for the organization (in Markdown)

billableboolean

entitlementLimitsEntitlementLimits (object)

totalStoragenumber

Storage entitlement, in bytes

computeTimePerYearnumber

Total compute time entitlement (CPU + GPU), in seconds

gpuComputeTimePerYearnumber

GPU compute time entitlement, in seconds

numberOfProjectsinteger

Number of projects allowed for this organization

numberOfUsersinteger

Number of users allowed for this organization

contractStartDatestring (date-time)

The date in which the organization contract started. Compute time will be calculated from this date.

domainstring

The domain of the organization. The organization domain is used to add new users to an organization. For example, new @edgeimpulse.com would be added to the Edge Impulse organization if this organization has edgeimpulse.com as the domain.

Example: "edgeimpulse.com"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Restore an organization

White label admin only API to restore a deleted organization. All organization projects sharing the same deletion date as that of the organization will also be restored. If this is a trial organization that was never upgraded to a paid plan then the organization will be restored to its original trial state.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/restore

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Get organization jobs

White label admin only API to get the list of all jobs for a organization.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/jobs

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

Query parameters

limitinteger

Maximum number of results

offsetinteger

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

jobs*array of Job (object)

Active jobs

id*integer

Job id, use this to refer back to the job. The web socket API also uses this ID.

category*string

key*string

created*string (date-time)

When the job was created.

startedstring (date-time)

When the job was started.

finishedstring (date-time)

When the job was finished.

finishedSuccessfulboolean

Whether the job finished successfully.

jobNotificationUids*array of integer

The IDs of users who should be notified when a job is finished.

itemsinteger

additionalInfostring

Additional metadata associated with this job.

computeTimenumber

Job duration time in seconds from start to finished, measured by k8s job watcher.

createdByUserobject

id*integer

name*string

username*string

photostring

categoryCountinteger

Some job categories keep a counter on the job number, e.g. in synthetic data, so we know what the 1st, 2nd etc. job was in the UI.

totalJobCount*integer

Request

Response

Upload organization logo

Uploads and updates the organization logo

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/logo

Path parameters

organizationId*integer

Organization ID

Body

imagestring (binary)

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

urlstring

Request

Response

Upload organization header image

Uploads and updates the organization header image

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/header

Path parameters

organizationId*integer

Organization ID

Body

imagestring (binary)

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

urlstring

Request

Response

Get projects

Retrieve all projects for the organization.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/projects

Path parameters

organizationId*integer

Organization ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

projects*array of Project (object)

Array with projects

id*integer

Example: 1

name*string

Example: "Water hammer detection"

description*string

created*string (date-time)

Example: "2019-07-21T17:32:28Z"

owner*string

User or organization that owns the project

lastAccessedstring (date-time)

Example: "2019-07-21T17:32:28Z"

lastModifiedstring (date-time)

Example: "2019-07-21T17:32:28Z"

lastModificationDetailsstring

Details about the last modification

Example: "Data sample added"

logostring

Custom logo for this project (not available for all projects)

ownerUserIdinteger

ownerOrganizationIdinteger

ownerAvatarstring

URL of the project owner avatar, if any.

ownerIsDeveloperProfile*boolean

developerProfileUserIdinteger

User ID of the developer profile, if any.

collaborators*array of ProjectCollaborator (all of)

id*integer

Example: 1

username*string

Example: "janjongboom"

name*string

Example: "Jan Jongboom"

email*string

Example: "quijote@edgeimpulse.com"

photostring

Example: "https://usercdn.edgeimpulse.com/photos/1.jpg"

created*string (date-time)

Example: "2019-08-31T17:32:28Z"

lastSeenstring (date-time)

Example: "2019-08-31T17:32:28Z"

staffInfo*StaffInfo (object)

isStaff*boolean

hasSudoRights*boolean

companyNamestring

pending*boolean

lastTosAcceptanceDatestring (date-time)

Example: "2019-08-31T17:32:28Z"

jobTitlestring

Example: "Software Engineer"

permissionsarray of Permission (enum)

List of permissions the user has

itemsPermission (enum)

companyNamestring

Example: "Edge Impulse Inc."

activated*boolean

Whether the user has activated their account or not.

mfaConfigured*boolean

Whether the user has configured multi-factor authentication

stripeCustomerIdstring

Stripe customer ID, if any.

hasPendingPaymentsboolean

Whether the user has pending payments.

tierUserTierEnum (enum)

The user account tier.

freecommunity-plusprofessionalenterprise

isOwner*boolean

labelingMethod*enum

single_labelobject_detection

metadata*object

Metadata about the project

dataExplorerScreenshotstring

isEnterpriseProject*boolean

Whether this is an enterprise project

whitelabelId*nullable integer

Unique identifier of the white label this project belongs to, if any.

tagsarray of string

List of project tags

itemsstring

categorystring

Project category

Example: "Image classification"

licensestring

Public project license, if any.

tier*ProjectTierEnum (enum)

The project tier. This is "enterprise" for all organization projects, or the user tier for all user projects.

freecommunity-plusprofessionalenterprise

hasPublicVersion*boolean

Whether this project has been published or not.

isPublic*boolean

allowsLivePublicAccess*boolean

indPauseProcessingSamples*boolean

publicProjectListed*boolean

Request

Response

Get API keys

Retrieve all API keys. This does not return the full API key, but only a portion (for security purposes).

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/apikeys

Path parameters

organizationId*integer

Organization ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

apiKeys*array of object

List of API keys.

id*integer

apiKey*string

name*string

created*string (date-time)

role*enum

adminmember

isTransformationJobKey*boolean

Request

Response

Admin endpoint

Test endpoint that can only be reached with admin rights.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/test-admin

Path parameters

organizationId*integer

Organization ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

Add API key

Add an API key.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/apikeys

Path parameters

organizationId*integer

Organization ID

Body

name*string

Description of the key

apiKey*string

API key. This needs to start with ei_ and will need to be at least 32 characters long.

role*enum

adminmember

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

Revoke API key

Revoke an API key.

DELETEhttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/apikeys/{apiKeyId}

Path parameters

organizationId*integer

Organization ID

apiKeyId*integer

API key ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

Add member

Add a member to an organization.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/members/add

Path parameters

organizationId*integer

Organization ID

Body

usernameOrEmail*string

Username or e-mail address

role*OrganizationMemberRole (enum)

adminmemberguest

datasets*array of string

Only used for 'guest' users. Limits the datasets the user has access to.

itemsstring

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

Remove member

Remove a member from an organization. Note that you cannot invoke this function if only a single member is present to the organization.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/members/remove

Path parameters

organizationId*integer

Organization ID

Body

id*integer

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

Set member datasets

Set the datasets a guest member has access to in an organization.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/members/{memberId}/datasets

Path parameters

organizationId*integer

Organization ID

memberId*integer

Member ID

Body

datasets*array of string

itemsstring

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

Invite member

Invite a member to an organization.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/members/invite

Path parameters

organizationId*integer

Organization ID

Body

email*string

E-mail address

role*OrganizationMemberRole (enum)

adminmemberguest

datasets*array of string

Only used for 'guest' users. Limits the datasets the user has access to.

itemsstring

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

Set member role

Change the role of a member in an organization.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/members/{memberId}/role

Path parameters

organizationId*integer

Organization ID

memberId*integer

Member ID

Body

role*OrganizationMemberRole (enum)

adminmemberguest

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

Resend invitation

Resend an invitation to a member in an organization.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/members/{memberId}/resend-invite

Path parameters

organizationId*integer

Organization ID

memberId*integer

Member ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

Upload image for readme

Uploads an image to the user CDN and returns the path.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/readme/upload-image

Path parameters

organizationId*integer

Organization ID

Body

image*string (binary)

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

url*string

Request

Response

Get all organization data exports

Get all data exports for an organization.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/exports

Path parameters

organizationId*integer

Organization ID

Query parameters

limitinteger

Maximum number of results

offsetinteger

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

exports*array of OrganizationDataExport (object)

List of organization data exports.

id*integer

created*string (date-time)

createdByUserobject

id*integer

name*string

username*string

photostring

jobId*integer

jobFinished*boolean

jobFinishedSuccessful*boolean

descriptionstring

Description of the data export

expirationDate*string (date-time)

Date when the export will expire. Default is 30 days. Maximum expiration date is 60 days from the creation date.

downloadUrlstring

totalCount*integer

Request

Response

Get organization data export

Get a data export for an organization.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/exports/{exportId}

Path parameters

organizationId*integer

Organization ID

exportId*integer

Export ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

export*OrganizationDataExport (object)

id*integer

created*string (date-time)

createdByUserobject

id*integer

name*string

username*string

photostring

jobId*integer

jobFinished*boolean

jobFinishedSuccessful*boolean

descriptionstring

Description of the data export

expirationDate*string (date-time)

Date when the export will expire. Default is 30 days. Maximum expiration date is 60 days from the creation date.

downloadUrlstring

Request

Response

Download organization data export

Download a data export for an organization.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/exports/{exportId}/download

Path parameters

organizationId*integer

Organization ID

exportId*integer

Export ID

Response

A redirect to the ZIP file

Request

White Label Admin - Download usage report

Download a usage report for an organization. This is an API only available to white label admins.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/usage/reports/{reportId}/download

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

reportId*integer

Report ID

Response

A redirect to the CSV file

Request

Download organization data export

Download a data export for an organization.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/exports/{exportId}/download

Path parameters

organizationId*integer

Organization ID

exportId*integer

Export ID

Response

A redirect to the ZIP file

Request

Request HR block license

Request a license required for the deployment of an impulse containing the Edge Impulse HR block.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/request-hr-block-license

Path parameters

organizationId*integer

Organization ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

Get organization data export

Get a data export for an organization.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/exports/{exportId}

Path parameters

organizationId*integer

Organization ID

exportId*integer

Export ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

export*OrganizationDataExport (object)

id*integer

created*string (date-time)

createdByUserobject

id*integer

name*string

username*string

photostring

jobId*integer

jobFinished*boolean

jobFinishedSuccessful*boolean

descriptionstring

Description of the data export

expirationDate*string (date-time)

Date when the export will expire. Default is 30 days. Maximum expiration date is 60 days from the creation date.

downloadUrlstring

Request

Response

White Label Admin - Restore an organization

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/restore

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

Resend invitation

Resend an invitation to a member in an organization.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/members/{memberId}/resend-invite

Path parameters

organizationId*integer

Organization ID

memberId*integer

Member ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Remove a development board from a whitelabel

White label admin only API to remove a development board.

DELETEhttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/development-boards/{developmentBoardId}

Path parameters

organizationId*integer

Organization ID

developmentBoardId*integer

Development board ID.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Remove user from an organization

White label admin only API to remove a user from an organization.

DELETEhttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/members/{userId}

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

userId*integer

User ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

Admin endpoint

Test endpoint that can only be reached with admin rights.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/test-admin

Path parameters

organizationId*integer

Organization ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

Delete a user

White label admin only API to delete a user.

DELETEhttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/users/{userId}

Path parameters

organizationId*integer

Organization ID

userId*integer

User ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Delete a project

White label admin only API to delete a project.

DELETEhttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/projects/{projectId}

Path parameters

organizationId*integer

Organization ID

projectId*integer

Project ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Delete an organization

White label admin only API to delete an organization.

DELETEhttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

Remove organization

Remove the current organization, and all data associated with it. This is irrevocable!

DELETEhttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}

Path parameters

organizationId*integer

Organization ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Remove user from a project

White label admin only API to remove a user from a project.

DELETEhttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/projects/{projectId}/members/{userId}

Path parameters

organizationId*integer

Organization ID

projectId*integer

Project ID

userId*integer

User ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Delete usage report

Delete a usage report for an organization. This is an API only available to white label admins.

DELETEhttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/usage/reports/{reportId}

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

reportId*integer

Report ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Delete organization data export

Delete a data export for an organization. This is an API only available to white label admins.

DELETEhttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/exports/{exportId}

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

exportId*integer

Export ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

Revoke API key

Revoke an API key.

DELETEhttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/apikeys/{apiKeyId}

Path parameters

organizationId*integer

Organization ID

apiKeyId*integer

API key ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Get project jobs

White label admin only API to get the list of all jobs for a project.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/projects/{projectId}/jobs

Path parameters

organizationId*integer

Organization ID

projectId*integer

Project ID

Query parameters

limitinteger

Maximum number of results

offsetinteger

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

jobs*array of Job (object)

Active jobs

id*integer

Job id, use this to refer back to the job. The web socket API also uses this ID.

category*string

key*string

created*string (date-time)

When the job was created.

startedstring (date-time)

When the job was started.

finishedstring (date-time)

When the job was finished.

finishedSuccessfulboolean

Whether the job finished successfully.

jobNotificationUids*array of integer

The IDs of users who should be notified when a job is finished.

itemsinteger

additionalInfostring

Additional metadata associated with this job.

computeTimenumber

Job duration time in seconds from start to finished, measured by k8s job watcher.

createdByUserobject

id*integer

name*string

username*string

photostring

categoryCountinteger

Some job categories keep a counter on the job number, e.g. in synthetic data, so we know what the 1st, 2nd etc. job was in the UI.

totalJobCount*integer

Request

Response

Remove member

Remove a member from an organization. Note that you cannot invoke this function if only a single member is present to the organization.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/members/remove

Path parameters

organizationId*integer

Organization ID

Body

id*integer

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Update theme favicon

White label admin only API to update the theme favicon.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/theme/favicon

Path parameters

organizationId*integer

Organization ID

Body

image*string (binary)

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

Set member datasets

Set the datasets a guest member has access to in an organization.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/members/{memberId}/datasets

Path parameters

organizationId*integer

Organization ID

memberId*integer

Member ID

Body

datasets*array of string

itemsstring

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Update a development board in a whitelabel

White label admin only API to update a development board.

PUThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/development-boards/{developmentBoardId}

Path parameters

organizationId*integer

Organization ID

developmentBoardId*integer

Development board ID.

Body

namestring

imagestring

docsUrlstring

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Update deployment targets

White label admin only API to update some or all of the deployment targets enabled for this white label.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/deploymentTargets

Path parameters

organizationId*integer

Organization ID

Body

targetsarray of string

The names of the deployment targets that are enabled for this whitelabel.

itemsstring

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Update learning blocks

White label admin only API to update some or all of the learning blocks enabled for this white label.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/learningBlocks

Path parameters

organizationId*integer

Organization ID

Body

learningBlocksarray of string

The types of the learning blocks that are enabled for this whitelabel.

itemsstring

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Get global white label metrics

White label admin only API to get global metrics.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/metrics

Path parameters

organizationId*integer

Organization ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

metrics*object

Request

Response

White Label Admin - Get white label user metrics

White label admin only API to get marketing metrics about a user.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/users/{userId}/metrics

Path parameters

organizationId*integer

Organization ID

userId*integer

User ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

metrics*object

Request

Response

White Label Admin - Get user jobs

White label admin only API to get the list of all project jobs for a user.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/users/{userId}/jobs

Path parameters

organizationId*integer

Organization ID

userId*integer

User ID

Query parameters

limitinteger

Maximum number of results

offsetinteger

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

jobs*array of Job (object)

Active jobs

id*integer

Job id, use this to refer back to the job. The web socket API also uses this ID.

category*string

key*string

created*string (date-time)

When the job was created.

startedstring (date-time)

When the job was started.

finishedstring (date-time)

When the job was finished.

finishedSuccessfulboolean

Whether the job finished successfully.

jobNotificationUids*array of integer

The IDs of users who should be notified when a job is finished.

itemsinteger

additionalInfostring

Additional metadata associated with this job.

computeTimenumber

Job duration time in seconds from start to finished, measured by k8s job watcher.

createdByUserobject

id*integer

name*string

username*string

photostring

categoryCountinteger

Some job categories keep a counter on the job number, e.g. in synthetic data, so we know what the 1st, 2nd etc. job was in the UI.

totalJobCount*integer

Request

Response

White Label Admin - Creates a new usage report

Create a new usage report for an organization. A job is created to process the report request and the job details are returned in the response. This is an API only available to white label admins.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/usage/reports

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

Query parameters

startDate*string (date-time)

Start date

endDate*string (date-time)

End date

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

id*integer

Job identifier. Status updates will include this identifier.

Example: 12873488112

Request

Response

White Label Admin - Get all organization data exports

Get all data exports for an organization. This is an API only available to white label admins.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/exports

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

Query parameters

limitinteger

Maximum number of results

offsetinteger

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

exports*array of OrganizationDataExport (object)

List of organization data exports.

id*integer

created*string (date-time)

createdByUserobject

id*integer

name*string

username*string

photostring

jobId*integer

jobFinished*boolean

jobFinishedSuccessful*boolean

descriptionstring

Description of the data export

expirationDate*string (date-time)

Date when the export will expire. Default is 30 days. Maximum expiration date is 60 days from the creation date.

downloadUrlstring

totalCount*integer

Request

Response

Upload organization header image

Uploads and updates the organization header image

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/header

Path parameters

organizationId*integer

Organization ID

Body

imagestring (binary)

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

urlstring

Request

Response

White Label Admin - Update theme device logo

White label admin only API to update the white label theme device logo.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/theme/deviceLogo

Path parameters

organizationId*integer

Organization ID

Body

imagestring (binary)

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

urlstring

Request

Response

White Label Admin - Update default deployment target

White label admin only API to update the default deployment target for this white label.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/deploymentTargets/default

Path parameters

organizationId*integer

Organization ID

Body

defaultDeploymentTarget*nullable string

Name of the default deployment target

Example: "C++ library"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Update the image of a whitelabel development board

White label admin only API to update the image of a development board.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/development-boards/{developmentBoardId}/image

Path parameters

organizationId*integer

Organization ID

developmentBoardId*integer

Development board ID.

Body

imagestring (binary)

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

urlstring

Request

Response

White Label Admin - Update theme logo

White label admin only API to update the white label theme logo.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/theme/logo

Path parameters

organizationId*integer

Organization ID

Body

imagestring (binary)

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

urlstring

Request

Response

White Label Admin - Update organization data export

Update a data export for an organization. This is an API only available to white label admins.

PUThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/exports/{exportId}

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

exportId*integer

Export ID

Body

descriptionstring

Description of the data export

expirationDatestring (date-time)

Date when the export will expire. Default is 30 days. Maximum expiration date is 60 days from the creation date.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

Upload organization logo

Uploads and updates the organization logo

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/logo

Path parameters

organizationId*integer

Organization ID

Body

imagestring (binary)

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

urlstring

Request

Response

White Label Admin - Get organization compute time usage

Get compute time usage for an organization over a period of time. This is an API only available to white label admins

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/usage/computeTime

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

Query parameters

startDate*string (date-time)

Start date

endDate*string (date-time)

End date

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

cpuComputeTimenumber

CPU compute time in seconds of all jobs in the organization (including organizational project jobs).

gpuComputeTimenumber

GPU compute time in seconds of all jobs in the organization (including organizational project jobs).

totalComputeTimenumber

Total compute time is the amount of computation time spent in jobs, in minutes used by an organization over the given period, calculated as CPU + GPU minutes.

Request

Response

Upload image for readme

Uploads an image to the user CDN and returns the path.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/readme/upload-image

Path parameters

organizationId*integer

Organization ID

Body

image*string (binary)

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

url*string

Request

Response

White Label Admin - Update theme colors

White label admin only API to update some or all theme colors.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/theme/colors

Path parameters

organizationId*integer

Organization ID

Body

primaryColorstring

Primary color in hex format

primaryColorGradientEndstring

Primary color gradient end in hex format

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

Set member role

Change the role of a member in an organization.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/members/{memberId}/role

Path parameters

organizationId*integer

Organization ID

memberId*integer

Member ID

Body

role*OrganizationMemberRole (enum)

adminmemberguest

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Add user to a project

White label admin only API to add a user to a project. If no user is provided, the current user is used.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/projects/{projectId}/members

Path parameters

organizationId*integer

Organization ID

projectId*integer

Project ID

Body

usernameOrEmailstring

Username or email of the user to be added to the project or organization. If no user is provided, the user ID attached to the JWT will be used.

Example: "janjongboom"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Create a new organization data export

Create a new data export for an organization. A job is created to process the export request and the job details are returned in the response. This is an API only available to white label admins.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/exports

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

Body

description*string

Description of the data export

expirationDatestring (date-time)

Date when the export will expire. Default is 30 days. Maximum expiration date is 60 days from the creation date.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

id*integer

Job identifier. Status updates will include this identifier.

Example: 12873488112

Request

Response

White Label Admin - Update white label information

White label admin only API to update the white label information.

PUThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel

Path parameters

organizationId*integer

Organization ID

Body

supportedProjectTypesarray of ProjectType (enum)

itemsProjectType (enum)

kwsaudioobject-detectionimageaccelerometerother

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Update the order of deployment options in the deployment view

White label admin only API to customize the order of deployment options in the deployment view for this white label.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/deploymentOptionsOrder

Path parameters

organizationId*integer

Organization ID

Body

orderDeploymentOptionsOrder (array of string)

Optional attribute allowing a whitelabel to customize the order of deployment options in the deployment view, given as an in-order list of deployment options.

itemsstring

Deployment option name

Example: "org-1"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Add a development board to a whitelabel

White label admin only API to add a development board.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/development-boards

Path parameters

organizationId*integer

Organization ID

Body

name*string

image*string

docsUrl*string

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

id*integer

Request

Response

White Label Admin - Add Project API key

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/projects/{projectId}/apiKeys

Path parameters

organizationId*integer

Organization ID

projectId*integer

Project ID

Body

name*string

Description of the key

apiKey*string

API key. This needs to start with ei_ and will need to be at least 32 characters long.

ttlinteger

Time to live in seconds. If not set, the key will expire in 1 minute.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Add organization API key

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/apiKeys

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

Body

name*string

Description of the key

apiKey*string

API key. This needs to start with ei_ and will need to be at least 32 characters long.

role*enum

adminmember

ttlinteger

Time to live in seconds. If not set, the key will expire in 1 minute.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

Add API key

Add an API key.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/apikeys

Path parameters

organizationId*integer

Organization ID

Body

name*string

Description of the key

apiKey*string

API key. This needs to start with ei_ and will need to be at least 32 characters long.

role*enum

adminmember

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

Get API keys

Retrieve all API keys. This does not return the full API key, but only a portion (for security purposes).

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/apikeys

Path parameters

organizationId*integer

Organization ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

apiKeys*array of object

List of API keys.

id*integer

apiKey*string

name*string

created*string (date-time)

role*enum

adminmember

isTransformationJobKey*boolean

Request

Response

Request trial extension

Request an extension for an enterprise trial.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/trial/request-extension

Path parameters

organizationId*integer

Organization ID

Body

reasonstring

Answer to the question: 'Why is this the right time for your team to invest in edge AI?'. This is optional.

useCasestring

Answer to the question: 'What best describes your use case?'. This is optional.

timelinestring

Answer to the question: 'What is your timeline for solving your problem?'. This is optional.

objectivestring

Answer to the question: 'What are you hoping to achieve with an extension?'. This is optional.

trialIdnumber

The user's trial ID. This is optional.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Add user to an organization

White label admin only API to add a user to an organization. If no user is provided, the current user is used.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/members

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

Body

usernameOrEmailstring

Username or email of the user to be added to the project or organization. If no user is provided, the user ID attached to the JWT will be used.

Example: "janjongboom"

role*OrganizationMemberRole (enum)

adminmemberguest

datasets*array of string

Only used for 'guest' users. Limits the datasets the user has access to.

itemsstring

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

Add member

Add a member to an organization.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/members/add

Path parameters

organizationId*integer

Organization ID

Body

usernameOrEmail*string

Username or e-mail address

role*OrganizationMemberRole (enum)

adminmemberguest

datasets*array of string

Only used for 'guest' users. Limits the datasets the user has access to.

itemsstring

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

Invite member

Invite a member to an organization.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/members/invite

Path parameters

organizationId*integer

Organization ID

Body

email*string

E-mail address

role*OrganizationMemberRole (enum)

adminmemberguest

datasets*array of string

Only used for 'guest' users. Limits the datasets the user has access to.

itemsstring

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

Update organization

Update organization properties such as name and logo.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}

Path parameters

organizationId*integer

Organization ID

Body

logostring

New logo URL, or set to null to remove the logo.

headerImgstring

New leader image URL, or set to null to remove the leader.

showHeaderImgMaskboolean

namestring

New organization name.

experimentsarray of string

itemsstring

readmestring

Readme for the organization (in Markdown)

jobLimitMinteger

New job limit in seconds.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Create new organization within white label context

Create a new organization. This is an API only available to white label admins

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations

Path parameters

organizationId*integer

Organization ID

Body

organizationName*string

The name of the organization.

Example: "EdgeImpulse Inc."

adminIdinteger

Unique identifier of the administrator of the new organization.

Example: 1

adminEmailstring

Email of the administrator of the new organization.

Example: "jan@edgeimpulse.com"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

id*integer

Organization ID for the new organization

apiKey*string

API key for the new organization (this is shown only once)

Request

Response

White Label Admin - Update white label user

White label admin only API to update user properties.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/users/{userId}

Path parameters

organizationId*integer

Organization ID

userId*integer

User ID

Body

emailstring

New email. This will also update the forum's email address but the user may need to logout/login back

Example: "quijote@lamancha.es"

namestring

New user full name

Example: "Don Quijote de la Mancha"

activatedboolean

Whether the user is active or not. Can only go from inactive to active.

Example: true

suspendedboolean

Whether the user is suspended or not.

Example: false

jobTitlestring

New user job title

Example: "Knight"

experimentsarray of string

List of user experiments

itemsstring

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

Request

Response

White Label Admin - Create a new project within white label context.

Create a new free tier project. This is an API only available to white label admins.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/projects

Path parameters

organizationId*integer

Organization ID

Body

projectName*string

The name of the project.

Example: "My project"

projectVisibilityProjectVisibility (enum)

publicprivate

ownerIdinteger

Unique identifier of the owner of the new project. Either this parameter or ownerEmail must be set.

Example: 1

ownerEmailstring

Email of the owner of the new project. Either this parameter or ownerId must be set.

Example: "groucho@marxbros.com"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

id*integer

Project ID for the new project

apiKey*string

API key for the new project

Request

Response

White Label Admin - Get usage report

Get a usage report for an organization. This is an API only available to white label admins.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/usage/reports/{reportId}

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

reportId*integer

Report ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

report*Report (object)

id*integer

created*string (date-time)

createdByUserobject

id*integer

name*string

username*string

photostring

jobId*integer

jobFinished*boolean

jobFinishedSuccessful*boolean

downloadLinkstring

reportStartDate*string (date-time)

reportEndDate*string (date-time)

Request

Response

White Label Admin - Create a new organization project

White label admin only API to create a new project for an organization.

POSThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/projects

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

Body

projectName*string

The name of the project.

Example: "My project"

projectVisibilityProjectVisibility (enum)

publicprivate

ownerIdinteger

Unique identifier of the owner of the new project. Either this parameter or ownerEmail must be set.

Example: 1

ownerEmailstring

Email of the owner of the new project. Either this parameter or ownerId must be set.

Example: "groucho@marxbros.com"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

id*integer

Project ID for the new project

apiKey*string

API key for the new project

Request

Response

White Label Admin - Get all organizations within a white label

White label admin only API to get the list of all organizations.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations

Path parameters

organizationId*integer

Organization ID

Query parameters

activeinteger

Whether to search for entities (users, orgs) active in the last X days

includeDeletedboolean

Whether to include deleted entities (users, projects, orgs)

sortstring

Comma separated list of fields to sort query by. Prefix with a minus (-) sign to indicate descending order. Default order is ascending

Example: "id,-name"

filtersstring

Comma separated list of filters to apply to the query. Filters should be in the format 'field:value'.

Example: "billable:true"

limitinteger

Maximum number of results

offsetinteger

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

searchstring

Search query

Example: "<id> <name>"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

total*integer

organizations*array of object

Array with organizations

id*integer

Example: 1

name*string

Example: "Edge Impulse Inc."

logostring

created*string (date-time)

Example: "2019-08-31T17:32:28Z"

readmestring

experimentsarray of string

itemsstring

domainstring

whitelabelIdinteger

billableboolean

privateProjectCount*integer

entitlementLimitsEntitlementLimits (object)

totalStoragenumber

Storage entitlement, in bytes

computeTimePerYearnumber

Total compute time entitlement (CPU + GPU), in seconds

gpuComputeTimePerYearnumber

GPU compute time entitlement, in seconds

numberOfProjectsinteger

Number of projects allowed for this organization

numberOfUsersinteger

Number of users allowed for this organization

Request

Response

White Label Admin - Get organization data export

Get a data export for an organization. This is an API only available to white label admins.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/exports/{exportId}

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

exportId*integer

Export ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

export*OrganizationDataExport (object)

id*integer

created*string (date-time)

createdByUserobject

id*integer

name*string

username*string

photostring

jobId*integer

jobFinished*boolean

jobFinishedSuccessful*boolean

descriptionstring

Description of the data export

expirationDate*string (date-time)

Date when the export will expire. Default is 30 days. Maximum expiration date is 60 days from the creation date.

downloadUrlstring

Request

Response

White Label Admin - Get all usage reports

Get all usage reports for an organization. This is an API only available to white label admins.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/organizations/{innerOrganizationId}/usage/reports

Path parameters

organizationId*integer

Organization ID

innerOrganizationId*integer

Organization ID within the context of a white label

Query parameters

limitinteger

Maximum number of results

offsetinteger

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

reports*array of Report (object)

List of organization usage reports.

id*integer

created*string (date-time)

createdByUserobject

id*integer

name*string

username*string

photostring

jobId*integer

jobFinished*boolean

jobFinishedSuccessful*boolean

downloadLinkstring

reportStartDate*string (date-time)

reportEndDate*string (date-time)

totalCount*integer

Request

Response

Get all organization data exports

Get all data exports for an organization.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/exports

Path parameters

organizationId*integer

Organization ID

Query parameters

limitinteger

Maximum number of results

offsetinteger

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

exports*array of OrganizationDataExport (object)

List of organization data exports.

id*integer

created*string (date-time)

createdByUserobject

id*integer

name*string

username*string

photostring

jobId*integer

jobFinished*boolean

jobFinishedSuccessful*boolean

descriptionstring

Description of the data export

expirationDate*string (date-time)

Date when the export will expire. Default is 30 days. Maximum expiration date is 60 days from the creation date.

downloadUrlstring

totalCount*integer

Request

Response

White Label Admin - Get all white label users

White label admin only API to get the list of all registered users.

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/whitelabel/users

Path parameters

organizationId*integer

Organization ID

Query parameters

activeinteger

Whether to search for entities (users, orgs) active in the last X days

tierUserTierEnum (enum)

The user account tier.

freecommunity-plusprofessionalenterprise

fieldsstring

Comma separated list of fields to fetch in a query

Example: "id,name"

sortstring

Comma separated list of fields to sort query by. Prefix with a minus (-) sign to indicate descending order. Default order is ascending

Example: "id,-name"

filtersstring

Comma separated list of filters to apply to the query. Filters should be in the format 'field:value'.

Example: "billable:true"

limitinteger

Maximum number of results

offsetinteger

Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.

searchstring

Search query

Example: "<id> <name>"

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

total*integer

users*array of object

id*integer

Example: 1

username*string

Example: "janjongboom"

email*string

Example: "jan@edgeimpulse.com"

name*string

Example: "Jan Jongboom"

photostring

Example: "https://usercdn.edgeimpulse.com/photos/1.jpg"

created*string (date-time)

Example: "2019-08-31T17:32:28Z"

lastSeenstring (date-time)

Example: "2019-08-31T17:32:28Z"

activatedboolean

from_evaluationboolean

tierUserTierEnum (enum)

The user account tier.

freecommunity-plusprofessionalenterprise

Request

Response