POST
/
api
/
projects
/
create
Create new project
curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/projects/create \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "projectName": "EEG trials",
  "projectVisibility": "public",
  "originalProjectVersionId": 123,
  "showGettingStartedWizard": true,
  "tutorialKey": "kws"
}'
{
  "success": true,
  "error": "<string>",
  "id": 123,
  "apiKey": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
projectName
string
required

The name of the first project.

Example:

"EEG trials"

​
projectVisibility
enum<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 can only be viewed and edited by collaborators.

Available options:
public,
private
​
originalProjectVersionId
integer

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

​
showGettingStartedWizard
boolean

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

​
tutorialKey
enum<string>

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

Available options:
kws,
cv

Response

200 - application/json

OK

​
success
boolean
required

Whether the operation succeeded

​
id
integer
required

Project ID for the new project

​
apiKey
string
required

API key for the new project

​
error
string

Optional error description (set if 'success' was false)