Create new empty project

Create new empty project

post

Create a new empty project within an organization.

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

organizationIdintegerRequired

Organization ID

Body

projectNamestringRequired

The name of the project.

Example: EEG trials

projectVisibilitystring · enumOptional

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.

Possible values:

projectOwnerUsernameOrEmailstringOptional

The username or email of the owner of the project. This field is mandatory when authenticating via API key. If no email is provided when authenticating via JWT, the user ID attached to the JWT will be user as project owner.

Example: [email protected]

showGettingStartedWizardbooleanOptional

Whether to show the getting started wizard use-case chooser screen after the project is created

tutorialKeystring · enumOptional

Optional in-product tutorial to launch after the project is created

Possible values:

Responses

200

OK

application/json

Responseall of

post

HTTPcURLJavaScriptPython

POST /v1/api/organizations/{organizationId}/new-project HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 161

{
  "projectName": "EEG trials",
  "projectVisibility": "public",
  "projectOwnerUsernameOrEmail": "[email protected]",
  "showGettingStartedWizard": true,
  "tutorialKey": "kws"
}

200

OK

{
  "success": true,
  "error": "text",
  "id": 1,
  "apiKey": "text"
}