EDedgeimpulse
User

Start enterprise trial

Create an enterprise trial for the current user. Users can only go through a trial once.

post/api/user/trial

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
    A function with typed inputs. Its response is checked against the schema.

Request body

emailstring

Email of the user requesting the trial. If this email is different to the one stored for the user requesting the trial, it will be used to replace the existing one.

namestring

Name of the user requesting the trial. If this name is different to the one stored for the user requesting the trial, it will be used to replace the existing one.

organizationNamestring

Name of the trial organization. All enterprise features are tied to an organization. This organization will be deleted after the trial ends. If no organization name is provided, the user's name will be used.

expirationDatestring date-time

Expiration date of the trial. The trial will be set as expired after this date. There will be a grace period of 30 days after a trial expires before fully deleting the trial organization. This field is ignored if the trial is requested by a non-admin user, defaulting to 14 days trial.

notesstring

Notes about the trial. Free form text. This field is ignored if the trial is requested by a non-admin user.

useCasestring

Use case of the trial.

userHasMLModelsInProduction'yes' | 'no' | 'no, but we will soon'

Whether the user has ML models in production.

companyNamestring

Name of the company requesting the trial.

companySizestring

Size of the company requesting the trial. This is a range of number of employees.

countrystring

Country of the company requesting the trial.

stateOrProvincestring

State or province of the company requesting the trial.

redirectUrlOriginstring

Origin of the redirect URL returned as result of creating the trial user.

redirectUrlQueryParamsstring

Query parameters to be appended to the redirect URL returned as result of creating the trial user.

Example request

{
  "email": "fred@flintstones.org",
  "name": "Fred Flintstone",
  "organizationName": "My Company",
  "expirationDate": "2020-01-01T00:00:00Z",
  "notes": "This is a trial for the company's new project.",
  "useCase": "Industrial",
  "userHasMLModelsInProduction": "no",
  "companyName": "ACME Inc.",
  "companySize": "1-10",
  "country": "United States",
  "stateOrProvince": "California",
  "redirectUrlOrigin": "https://studio.edgeimpulse.com",
  "redirectUrlQueryParams": "utm_source=google&utm_medium=cpc&utm_campaign=trial"
}

Response

OK

successboolean required

Whether the operation succeeded

errorstring

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

idinteger required

Unique identifier of the created entity.

userIdinteger

ID of the user created for the trial, if the user did not already exist.

redirectUrlstring required

URL to redirect the user to in order to access the enterprise trial.

Changes

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