OrganizationCreateProject

Create new empty project

Create a new empty project within an organization.

post/api/organizations/{organizationId}/new-project

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/organizations/:organizationId/new-project/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

organizationIdinteger required

Organization ID

Request body

projectNamestring required

The name of the 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.

projectOwnerUsernameOrEmailstring

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.

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",
  "projectOwnerUsernameOrEmail": "jan@edgeimpulse.com"
}

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.