---
title: "Start enterprise trial"
method: POST
path: "/api/user/trial"
tags: ["User"]
---

# Start enterprise trial

`POST /api/user/trial`

## Request

- Base URL: `https://studio.edgeimpulse.com/v1`
- URL: `https://studio.edgeimpulse.com/v1/api/user/trial`
- Auth: one of:
  - API key in header `x-api-key`
  - API key in cookie `jwt`
  - API key in header `x-jwt-token`
  - 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/user/trial/post.ts> (a function with typed inputs; its response is checked against the schema)

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

## Request body

- StartEnterpriseTrialRequest
  - `email` string: 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.
  - `name` string: 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.
  - `organizationName` string: 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.
  - `expirationDate` string, 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.
  - `notes` string: Notes about the trial. Free form text. This field is ignored if the trial is requested by a non-admin user.
  - `useCase` string: Use case of the trial.
  - `userHasMLModelsInProduction` 'yes' | 'no' | 'no, but we will soon': Whether the user has ML models in production.
  - `companyName` string: Name of the company requesting the trial.
  - `companySize` string: Size of the company requesting the trial. This is a range of number of employees.
  - `country` string: Country of the company requesting the trial.
  - `stateOrProvince` string: State or province of the company requesting the trial.
  - `redirectUrlOrigin` string: Origin of the redirect URL returned as result of creating the trial user.
  - `redirectUrlQueryParams` string: Query parameters to be appended to the redirect URL returned as result of creating the trial user.

## Response `200`

OK

- CreateEnterpriseTrialResponse
  - `success` boolean, required: Whether the operation succeeded
  - `error` string: Optional error description (set if 'success' was false)
  - `id` integer, required: Unique identifier of the created entity.
  - `userId` integer: ID of the user created for the trial, if the user did not already exist.
  - `redirectUrl` string, required: URL to redirect the user to in order to access the enterprise trial.

---

[API](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api.md) - [All operations](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/llms.txt) - [OpenAPI document](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/revisions/e2a976d38427?raw)