Projects

Create new project

Create a new project. By default this endpoint creates and returns a project API key. When authenticated via OAuth, API key creation and API key return in the response are disabled.

post/api/projects/create

Request

Base URL
https://studio.edgeimpulse.com/v1
Auth
- API key in header x-api-key
- or API key in cookie jwt
- or API key in header x-jwt-token
- or OAuth 2
  Authorization code/v1/oauth/authorize
  Client credentials
  Implicit/v1/oauth/authorize
  Password
  Token URL/v1/oauth/token
TypeScript
https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/projects/create/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

projectNamestring required

The name of the first project.

projectVisibility'public' | 'private'

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.

originalProjectVersionIdinteger

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

showGettingStartedWizardboolean

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

tutorialKey'kws' | 'cv'

The type of in-product guided tutorial to show in the getting started wizard

createApiKeyboolean

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.

Example request

{
  "projectName": "EEG trials"
}

Response

successboolean required

Whether the operation succeeded

errorstring

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

idinteger required

Project ID for the new project

apiKeystring required

API key for the new project

Changes

No recorded changes to this operation across all 1 revision of this API.