Start enterprise trial

curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/user/trial \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data @- <<EOF
{
  "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"
}
EOF

import requests

url = "https://studio.edgeimpulse.com/v1/api/user/trial"

payload = {
    "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"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'
  })
};

fetch('https://studio.edgeimpulse.com/v1/api/user/trial', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://studio.edgeimpulse.com/v1/api/user/trial",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://studio.edgeimpulse.com/v1/api/user/trial"

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

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://studio.edgeimpulse.com/v1/api/user/trial")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"fred@flintstones.org\",\n  \"name\": \"Fred Flintstone\",\n  \"organizationName\": \"My Company\",\n  \"expirationDate\": \"2020-01-01T00:00:00Z\",\n  \"notes\": \"This is a trial for the company's new project.\",\n  \"useCase\": \"Industrial\",\n  \"userHasMLModelsInProduction\": \"no\",\n  \"companyName\": \"ACME Inc.\",\n  \"companySize\": \"1-10\",\n  \"country\": \"United States\",\n  \"stateOrProvince\": \"California\",\n  \"redirectUrlOrigin\": \"https://studio.edgeimpulse.com\",\n  \"redirectUrlQueryParams\": \"utm_source=google&utm_medium=cpc&utm_campaign=trial\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://studio.edgeimpulse.com/v1/api/user/trial")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"fred@flintstones.org\",\n  \"name\": \"Fred Flintstone\",\n  \"organizationName\": \"My Company\",\n  \"expirationDate\": \"2020-01-01T00:00:00Z\",\n  \"notes\": \"This is a trial for the company's new project.\",\n  \"useCase\": \"Industrial\",\n  \"userHasMLModelsInProduction\": \"no\",\n  \"companyName\": \"ACME Inc.\",\n  \"companySize\": \"1-10\",\n  \"country\": \"United States\",\n  \"stateOrProvince\": \"California\",\n  \"redirectUrlOrigin\": \"https://studio.edgeimpulse.com\",\n  \"redirectUrlQueryParams\": \"utm_source=google&utm_medium=cpc&utm_campaign=trial\"\n}"

response = http.request(request)
puts response.read_body

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

POST

api

user

trial

Start enterprise trial

curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/user/trial \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data @- <<EOF
{
  "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"
}
EOF

import requests

url = "https://studio.edgeimpulse.com/v1/api/user/trial"

payload = {
    "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"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'
  })
};

fetch('https://studio.edgeimpulse.com/v1/api/user/trial', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://studio.edgeimpulse.com/v1/api/user/trial",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://studio.edgeimpulse.com/v1/api/user/trial"

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

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://studio.edgeimpulse.com/v1/api/user/trial")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"fred@flintstones.org\",\n  \"name\": \"Fred Flintstone\",\n  \"organizationName\": \"My Company\",\n  \"expirationDate\": \"2020-01-01T00:00:00Z\",\n  \"notes\": \"This is a trial for the company's new project.\",\n  \"useCase\": \"Industrial\",\n  \"userHasMLModelsInProduction\": \"no\",\n  \"companyName\": \"ACME Inc.\",\n  \"companySize\": \"1-10\",\n  \"country\": \"United States\",\n  \"stateOrProvince\": \"California\",\n  \"redirectUrlOrigin\": \"https://studio.edgeimpulse.com\",\n  \"redirectUrlQueryParams\": \"utm_source=google&utm_medium=cpc&utm_campaign=trial\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://studio.edgeimpulse.com/v1/api/user/trial")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"fred@flintstones.org\",\n  \"name\": \"Fred Flintstone\",\n  \"organizationName\": \"My Company\",\n  \"expirationDate\": \"2020-01-01T00:00:00Z\",\n  \"notes\": \"This is a trial for the company's new project.\",\n  \"useCase\": \"Industrial\",\n  \"userHasMLModelsInProduction\": \"no\",\n  \"companyName\": \"ACME Inc.\",\n  \"companySize\": \"1-10\",\n  \"country\": \"United States\",\n  \"stateOrProvince\": \"California\",\n  \"redirectUrlOrigin\": \"https://studio.edgeimpulse.com\",\n  \"redirectUrlQueryParams\": \"utm_source=google&utm_medium=cpc&utm_campaign=trial\"\n}"

response = http.request(request)
puts response.read_body

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

Authorizations

x-api-key

string

header

required

Body

application/json

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.

Example:

"fred@flintstones.org"

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.

Example:

"Fred Flintstone"

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.

Example:

"My Company"

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.

Example:

"2020-01-01T00:00:00Z"

notes

string

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

Example:

"This is a trial for the company's new project."

useCase

string

Use case of the trial.

Example:

"Industrial"

userHasMLModelsInProduction

enum<string>

Whether the user has ML models in production.

Available options:

yes,

no,

no, but we will soon

Example:

"no"

companyName

string

Name of the company requesting the trial.

Example:

"ACME Inc."

companySize

string

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

Example:

"1-10"

country

string

Country of the company requesting the trial.

Example:

"United States"

stateOrProvince

string

State or province of the company requesting the trial.

Example:

"California"

redirectUrlOrigin

string

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

Example:

"https://studio.edgeimpulse.com"

redirectUrlQueryParams

string

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

Example:

"utm_source=google&utm_medium=cpc&utm_campaign=trial"

Response

200 - application/json

success

boolean

required

Whether the operation succeeded

integer

required

Unique identifier of the created entity.

redirectUrl

string

required

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

error

string

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

userId

integer

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

OVERVIEW

STUDIO API ENDPOINTS

Start enterprise trial

Authorizations

Body

Response