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

Edge Impulse OrganizationCreateProject API

The OrganizationCreateProject API from Edge Impulse — 10 operation(s) for organizationcreateproject.

Edge Impulse OrganizationCreateProject 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 OrganizationCreateProject. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 13 operations across 10 paths, and defines 20 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.

13 operations 10 paths 20 schemas 2 DELETE2 GET9 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 3

Edge Impulse OrganizationCreateProject 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 13

Across 10 paths, the API surfaces 13 operations — 2 DELETE, 2 GET, 9 POST. Each is listed below with its method, path, parameters, and response codes.

OrganizationCreateProject 13
GET
/api/organizations/{organizationId}/create-project
List transformation jobs
getOrganizationCreateProjects 4 params → 200
POST
/api/organizations/{organizationId}/create-project
Start transformation job
organizationCreateProject 1 param body → 200
GET
/api/organizations/{organizationId}/create-project/{createProjectId}
Get transformation job status
getOrganizationCreateProjectStatus 5 params → 200
POST
/api/organizations/{organizationId}/create-project/{createProjectId}
Update transformation job
updateOrganizationCreateProject 2 params body → 200
DELETE
/api/organizations/{organizationId}/create-project/{createProjectId}
Delete transformation job
deleteOrganizationCreateProject 2 params → 200
POST
/api/organizations/{organizationId}/create-project/{createProjectId}/transform/retry
Retry failed transform jobs
retryOrganizationTransform 2 params → 200
POST
/api/organizations/{organizationId}/create-project/{createProjectId}/transform/clear
Clear failed transform jobs
clearOrganizationTransform 2 params → 200
POST
/api/organizations/{organizationId}/create-project/{createProjectId}/upload/retry
Retry transformation upload job
retryOrganizationUpload 2 params → 200
DELETE
/api/organizations/{organizationId}/create-project/{createProjectId}/files/{createProjectFileId}
Delete create project file
deleteOrganizationCreateProjectFile 3 params → 200
POST
/api/organizations/{organizationId}/create-project/{createProjectId}/files/{createProjectFileId}/retry
Retry transformation file
retryOrganizationCreateProjectFile 3 params → 200
POST
/api/organizations/{organizationId}/custom-block
Upload a custom block
uploadCustomBlock 1 param body → 200
POST
/api/organizations/{organizationId}/new-project
Create new empty project
organizationCreateEmptyProject 1 param body → 200
POST
/api/organizations/{organizationId}/add-project-collaborator
Add a collaborator to a project within an organisation
organizationAddCollaborator 1 param body → 200

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are OrganizationCreateProject (38 properties), OrganizationCreateProjectRequest (22 properties), CreatedUpdatedByUser (4 properties), UploadCustomBlockRequest (3 properties). Each schema is shown below with its type and property counts.

UploadCustomBlockRequest
object
3 properties 3 required
OrganizationCreateProject
object
38 properties 19 required
OrganizationCreateProjectOutputDatasetPathRule
string
Defines the folder structure for writing to the output dataset. Used only when uploading into a default (non-clinical) dataset.
TransformationJobOperatesOnEnum
string
StartJobResponse
UpdateOrganizationAddCollaboratorRequest
object
2 properties 2 required
CreateProjectResponse
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…
UpdateOrganizationCreateEmptyProjectRequest
object
3 properties 1 required
OrganizationCreateProjectRequest
object
If uploadType is set to 'project', either projectId, newProjectName or both projectApiKey and projectHmacKey are required. projectId and newProjectName are onl…
22 properties 1 required
OrganizationGetCreateProjectsResponse
OrganizationDatasetTypeEnum
string
UpdateOrganizationCreateProjectRequest
object
2 properties
CreatedUpdatedByUser
object
4 properties 3 required
GenericApiResponse
object
2 properties 1 required
TransformationJobStatusEnum
string
OrganizationCreateProjectResponse
OrganizationCreateProjectWithFiles
OrganizationCreateProjectStatusResponse
OrganizationCreateProjectPathFilter
object
Filter, given as a dataset and path containing wildcards, used for creating transformation jobs
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

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