Edge Impulse Projects API is one of 38 APIs that Edge Impulse publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Project. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
60 operations
across 51 paths,
and defines 128 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against a single base URL, https://studio.edgeimpulse.com/v1.
The identity and technical contract details declared by the specification.
Edge Impulse Projects API declares
4 security schemes
for authenticating requests.
An API key is passed in the header as x-api-key (ApiKeyAuthentication).
An API key is passed in the cookie as jwt (JWTAuthentication).
An API key is passed in the header as x-jwt-token (JWTHttpHeaderAuthentication).
It supports OAuth 2.0 (OAuth2) using the authorizationCode, implicit, password and clientCredentials flows, exposing 3 scopes.
ListPublicProjectsResponse
UploadImageRequest
object
1 property
1 required
AIAction
object
10 properties
8 required
SetProjectDspFileSizeRequest
object
Only parameters set on this object will be updated.
1 property
1 required
LatencyDevice
object
8 properties
8 required
GetTargetConstraintsResponse
ProjectModelVariant
object
4 properties
4 required
Job
object
12 properties
5 required
ModelEngineShortEnum
string
ListPublicProjectTypes
object
1 property
1 required
AddCollaboratorRequest
object
1 property
1 required
UploadCsvWizardUploadedFileRequest
object
1 property
1 required
UpdateProjectTagsRequest
object
1 property
1 required
AddApiKeyRequest
object
2 properties
1 required
User
object
18 properties
9 required
MemorySpec
object
Describes performance characteristics of a particular memory type
2 properties
Device
object
12 properties
10 required
PreviewAIActionsSamplesRequest
object
5 properties
3 required
KerasModelVariantEnum
string
UserTierEnum
string
The user account tier.
UpdateAIActionRequest
object
7 properties
3 required
UpdateProjectRequest
object
Only fields set in this object will be updated.
43 properties
CreateProjectRequest
object
3 properties
1 required
GetCsvWizardUploadedFileInfo
ProjectVisibility
string
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…
ListPublicProjects
object
2 properties
2 required
StructuredLabel
object
A structured label contains a label, and the range for which this label is valid. endIndex is inclusive. E.g. { startIndex: 10, endIndex: 13, label: 'running'…
3 properties
3 required
ProjectDismissNotificationRequest
object
1 property
1 required
GenericApiResponse
object
2 properties
1 required
ListProjects
object
1 property
1 required
ProjectDataSummary
object
3 properties
3 required
AddHmacKeyRequest
object
3 properties
3 required
DevelopmentBoardResponse
object
4 properties
4 required
ProjectTierEnum
string
The project tier. This is "enterprise" for all organization projects, or the user tier for all user projects.
ApplicationBudget
object
Specifies limits for your specific application, as available RAM and ROM for the model's operation and the maximum allowed latency.
3 properties
ListPublicProjectTypesResponse
RemoveCollaboratorRequest
object
1 property
1 required
TargetProcessor
object
8 properties
AIActionsConfigStep
object
2 properties
2 required
Sensor
object
2 properties
2 required
Download
object
6 properties
3 required
AIActionsDataCategory
string
UploadReadmeImageResponse
ProjectTrainingDataSummaryResponse
AIActionsConfig
object
4 properties
2 required
BoundingBox
object
This has the absolute values for x/y/w/h (so 0..x (where x is the w/h of the image))
5 properties
5 required
Sample
object
41 properties
25 required
ProjectDataAxesSummaryResponse
TargetMemory
object
RAM and ROM specifications of target
2 properties
SetAIActionsOrderRequest
object
1 property
1 required
ProjectPublicData
object
15 properties
10 required
SampleProposedChanges
object
5 properties
UpdateVersionRequest
object
1 property
DevelopmentKeys
object
2 properties
TargetConstraintsDevice
object
4 properties
ListPublicVersionsResponse
LastModificationDateResponse
ProjectDataIntervalResponse
AllProjectModelVariants
array
All model variants relevant for all learn blocks in the project
TargetConstraints
object
3 properties
2 required
DevelopmentBoardsResponse
StaffInfo
object
3 properties
2 required
Project
object
29 properties
17 required
GetSyntheticDataConfigResponse
SetProjectComputeTimeRequest
object
Only parameters set on this object will be updated.
1 property
1 required
ProjectInfoSummaryResponse
TransferOwnershipOrganizationRequest
object
1 property
1 required
ResourceRange
object
Describes range of expected availability for an arbitrary resource
2 properties
AddProjectApiKeyRequest_2
Job_2
object
14 properties
6 required
CreatedUpdatedByUser
object
4 properties
3 required
User_2
object
18 properties
9 required
UpdateProjectRequest_2
object
Only fields set in this object will be updated.
50 properties
CreateProjectRequest_2
object
6 properties
1 required
ProjectApiKey
object
11 properties
6 required
StructuredLabel_2
object
A structured label contains a label, and the range for which this label is valid. endIndex is inclusive. E.g. { startIndex: 10, endIndex: 13, label: 'running'…
4 properties
3 required
AnomalyLabelsConfig
object
2 properties
2 required
ProjectDataSummary_2
object
7 properties
4 required
TutorialType
string
The type of in-product guided tutorial to show in the getting started wizard
Sensor_2
object
3 properties
3 required
AIActionsDataCategory_2
string
ProjectLabelingMethod
string
ProjectTrainingDataSummaryResponse_2
Sample_2
object
46 properties
26 required
SampleDatastream
object
8 properties
7 required
LastUpdatedByProjectApiKey
object
The project API key that last updated a sample.
2 properties
2 required
ApiKeyExtension
object
2 properties
2 required
SampleKeyValueLabels
object
2 properties
2 required
AddIngestionOnlyProjectApiKeyRequest
object
1 property
1 required
LastUpdatedByOAuthClient
object
The OAuth client that last updated a sample, and the user it is acting on behalf of.
3 properties
2 required
ProjectDataIntervalResponse_2
SampleLabelMapLabels
Structured sample labels in the form of a key-value map. This property is optional and only defined for samples with key-value labels.
ProjectHmacKey
object
6 properties
5 required
GetCurrentApiKeyInfoResponse
LastUpdatedByUser
object
The user who last updated a sample.
2 properties
2 required
Project_2
object
33 properties
17 required
LastUpdatedByDatasetVersionRestore
object
The dataset restore that last updated a sample.
4 properties
3 required
PublicProjectLicense
string
ProjectInfoSummaryResponse_2
DatasetSplitOptions
object
6 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Edge Impulse publishes across the network.
