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)

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

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.

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