Edge Impulse Projects API
The Projects API from Edge Impulse — 46 operation(s) for projects.
Edge Impulse Projects API is one of 34 APIs that Edge Impulse publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Projects. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 55 operations across 46 paths, and defines 88 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.
Requests are made against a single base URL, https://studio.edgeimpulse.com/v1.
55 operations
46 paths
88 schemas
5 DELETE28 GET22 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Edge Impulse Projects API declares
3 security schemes
for authenticating requests.
An API key is passed in the header as x-api-key (ApiKeyAuthentication).
An API key is passed in the cookie as jwt (JWTAuthentication).
An API key is passed in the header as x-jwt-token (JWTHttpHeaderAuthentication).
By default, every request must be authenticated.
Paths & Operations 55
Across 46 paths, the API surfaces 55 operations — 5 DELETE, 28 GET, 22 POST. Each is listed below with its method, path, parameters, and response codes.
Projects 55
GET
/api/projects
List active projects
POST
/api/projects/create
Create new project
GET
/api/{projectId}/devkeys
Get development keys
GET
/api/{projectId}/downloads
Get downloads
GET
/api/{projectId}/csv-wizard/download-config
Download CSV Wizard config
GET
/api/{projectId}/csv-wizard/uploaded-file
Get CSV Wizard uploaded file info
POST
/api/{projectId}/csv-wizard/uploaded-file
Store CSV Wizard uploaded file
GET
/api/{projectId}/csv-wizard/uploaded-file/download
Download CSV Wizard uploaded file
POST
/api/{projectId}/collaborators/add
Add collaborator
POST
/api/{projectId}/collaborators/remove
Remove collaborator
POST
/api/{projectId}/collaborators/transfer-ownership
Transfer ownership (user)
POST
/api/{projectId}/collaborators/transfer-ownership-org
Transfer ownership (organization)
GET
/api/{projectId}/hmackeys
Get HMAC keys
POST
/api/{projectId}/hmackeys
Add HMAC key
DELETE
/api/{projectId}/hmackeys/{hmacId}
Remove HMAC key
GET
/api/{projectId}/apikeys
Get API keys
POST
/api/{projectId}/apikeys
Add API key
DELETE
/api/{projectId}/apikeys/{apiKeyId}
Revoke API key
GET
/api/{projectId}/emails
List emails
GET
/api/{projectId}/socket-token
Get socket token
GET
/api/{projectId}/data-axes
Get data axes summary
GET
/api/{projectId}/data-summary
Get data summary
GET
/api/{projectId}/data-interval
Get the interval (in ms) of the training data
POST
/api/{projectId}/compute-time-limit
Set compute time limit
POST
/api/{projectId}/dsp-file-size-limit
Set DSP file size limit
GET
/api/{projectId}/versions
List versions
GET
/api/{projectId}/versions/public
List public versions
POST
/api/{projectId}/versions/{versionId}
Update version
DELETE
/api/{projectId}/versions/{versionId}
Delete versions
POST
/api/{projectId}/versions/{versionId}/make-private
Make version private
POST
/api/{projectId}/readme/upload-image
Upload image for readme
POST
/api/{projectId}/launch-getting-started
Launch getting started wizard
GET
/api/{projectId}/last-modification
Last modification
GET
/api/{projectId}/development-boards
Development boards
GET
/api/{projectId}/target-constraints
Get target constraints
POST
/api/{projectId}/target-constraints
Set target constraints
GET
/api/{projectId}/model-variants
Get a list of all model variants available for this project
POST
/api/{projectId}/dismiss-notification
Dismiss a notification
GET
/api/{projectId}/synthetic-data
Get synthetic data config
GET
/api/{projectId}/ai-actions
List AI Actions
POST
/api/{projectId}/ai-actions/order
Set AI Actions order
POST
/api/{projectId}/ai-actions/create
Create AI Action
GET
/api/{projectId}/ai-actions/new
Get new AI Actions config
GET
/api/{projectId}/ai-actions/{actionId}
Get AI Actions config
POST
/api/{projectId}/ai-actions/{actionId}
Save AI Actions config
DELETE
/api/{projectId}/ai-actions/{actionId}
Delete AI Actions config
POST
/api/{projectId}/ai-actions/{actionId}/preview-samples
Preview samples for AI Actions
GET
/api/{projectId}/ai-actions/{actionId}/clear-proposed-changes
Clear AI Actions proposed changes
POST
/api/{projectId}/tags
Update tags
GET
/api/projects/public
List public projects
GET
/api/projects/types
List public project types
GET
/api/{projectId}
Project information
POST
/api/{projectId}
Update project
DELETE
/api/{projectId}
Remove project
GET
/api/{projectId}/public-info
Public project information
Schemas 88
The contract defines 88 schemas that model the data the API accepts and returns. The most detailed are UpdateProjectRequest (43 properties), Sample (41 properties), Project (29 properties), User (18 properties). Each schema is shown below with its type and property counts.
ProjectDataIntervalResponse
ProjectCollaborator
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
DevelopmentKeysResponse
Sensor
object
2 properties
2 required
ModelEngineShortEnum
string
AddHmacKeyRequest
object
3 properties
3 required
GetSyntheticDataConfigResponse
ProjectInfoSummaryResponse
DevelopmentBoardResponse
object
4 properties
4 required
ListEmailResponse
ListProjects
object
1 property
1 required
ProjectInfoResponse
SetProjectDspFileSizeRequest
object
Only parameters set on this object will be updated.
1 property
1 required
Device
object
12 properties
10 required
KerasModelVariantEnum
string
UpdateVersionRequest
object
1 property
LastModificationDateResponse
UploadCsvWizardUploadedFileRequest
object
1 property
1 required
ProjectTrainingDataSummaryResponse
AllProjectModelVariants
array
All model variants relevant for all learn blocks in the project
PreviewAIActionsSamplesRequest
object
5 properties
3 required
SocketTokenResponse
ProjectDataSummary
object
3 properties
3 required
ListHmacKeysResponse
AddApiKeyRequest
object
2 properties
1 required
SetAIActionsOrderRequest
object
1 property
1 required
AddCollaboratorRequest
object
1 property
1 required
MemorySpec
object
Describes performance characteristics of a particular memory type
2 properties
GetCsvWizardUploadedFileInfo
Permission
string
Job
object
12 properties
5 required
ProjectPublicData
object
15 properties
10 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
AIAction
object
10 properties
8 required
User
object
18 properties
9 required
UpdateAIActionRequest
object
7 properties
3 required
GetTargetConstraintsResponse
AIActionsConfigStep
object
2 properties
2 required
EntityCreatedResponse
ListPublicProjectTypesResponse
CreateProjectRequest
object
3 properties
1 required
AIActionsDataCategory
string
SetProjectComputeTimeRequest
object
Only parameters set on this object will be updated.
1 property
1 required
ProjectDismissNotificationRequest
object
1 property
1 required
UploadImageRequest
object
1 property
1 required
ListApiKeysResponse
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…
AddProjectApiKeyRequest
TargetProcessor
object
8 properties
ListSamplesResponse
UpdateProjectTagsRequest
object
1 property
1 required
LatencyDevice
object
8 properties
8 required
UserTierEnum
string
The user account tier.
Download
object
6 properties
3 required
ListProjectsResponse
StaffInfo
object
3 properties
2 required
GetModelVariantsResponse
TargetConstraintsDevice
object
4 properties
SampleProposedChanges
object
5 properties
ListAIActionsResponse
ProjectType
string
RemoveCollaboratorRequest
object
1 property
1 required
ListPublicProjects
object
2 properties
2 required
ListPublicProjectsResponse
ProjectDownloadsResponse
GenericApiResponse
object
2 properties
1 required
ListVersionsResponse
CreateProjectResponse
ProjectModelVariant
object
4 properties
4 required
UploadReadmeImageResponse
TargetConstraints
object
3 properties
2 required
ResourceRange
object
Describes range of expected availability for an arbitrary resource
2 properties
Project
object
29 properties
17 required
DevelopmentKeys
object
2 properties
ListPublicVersionsResponse
DevelopmentBoardsResponse
TransferOwnershipOrganizationRequest
object
1 property
1 required
ProjectTierEnum
string
The project tier. This is "enterprise" for all organization projects, or the user tier for all user projects.
UpdateProjectRequest
object
Only fields set in this object will be updated.
43 properties
ProjectDataAxesSummaryResponse
AIActionsConfig
object
4 properties
2 required
AddApiKeyResponse
ListPublicProjectTypes
object
1 property
1 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
TargetMemory
object
RAM and ROM specifications of target
2 properties
Sample
object
41 properties
25 required
GetAIActionResponse
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Edge Impulse 12
Other APIs Edge Impulse publishes across the network.
Edge Impulse Admin API
Edge Impulse Auth API
Edge Impulse Canary API
Edge Impulse CDN API
Edge Impulse Classify API
Edge Impulse Deployment API
Edge Impulse Devices API
Edge Impulse DSP API
Edge Impulse EmailVerification API
Edge Impulse Export API
Edge Impulse FeatureFlags API
Edge Impulse Health API
#Projects