Create new project

Create new project

post

Create a new project. This API can only be called using a JWT token.

Authorizations
Body
projectNamestringRequired

The name of the first 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:
originalProjectVersionIdintegerOptional

The ID of the version that was used to restore this project.

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
POST /v1/api/projects/create HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 138

{
  "projectName": "EEG trials",
  "projectVisibility": "public",
  "originalProjectVersionId": 1,
  "showGettingStartedWizard": true,
  "tutorialKey": "kws"
}
200

OK

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

Last updated

Was this helpful?