Create new project

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

POST /api/projects/create

Create new project

cURL

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",
  "createApiKey": true
}
'

200

{
  "success": true,
  "id": 123,
  "apiKey": "<string>",
  "error": "<string>"
}

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2

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 create

Available options: kws, cv

createApiKey · boolean

Whether to create an API key. If set to FALSE, the "apiKey" property on the response will be empty. If this field is not set, it will default to TRUE.

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)