Launch an experiment
curl --request POST \
--url https://api.zelto.ai/v1/experiments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"armAVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"armBVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"outcomeMetricIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"primaryMetricId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stableRoutingConfirmed": true,
"description": "<string>",
"armAName": "<string>",
"armBName": "<string>",
"cohortFilters": [
{}
],
"assignmentUnit": {
"kind": "auto"
},
"expectedArmAPercent": 50,
"monitorGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"newMonitorGroupName": "<string>",
"notifications": {
"emails": [
"jsmith@example.com"
]
}
}
'import requests
url = "https://api.zelto.ai/v1/experiments"
payload = {
"name": "<string>",
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"armAVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"armBVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"outcomeMetricIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"primaryMetricId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stableRoutingConfirmed": True,
"description": "<string>",
"armAName": "<string>",
"armBName": "<string>",
"cohortFilters": [{}],
"assignmentUnit": { "kind": "auto" },
"expectedArmAPercent": 50,
"monitorGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"newMonitorGroupName": "<string>",
"notifications": { "emails": ["jsmith@example.com"] }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
agentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
armAVersionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
armBVersionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
outcomeMetricIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
primaryMetricId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
stableRoutingConfirmed: true,
description: '<string>',
armAName: '<string>',
armBName: '<string>',
cohortFilters: [{}],
assignmentUnit: {kind: 'auto'},
expectedArmAPercent: 50,
monitorGroupId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
newMonitorGroupName: '<string>',
notifications: {emails: ['jsmith@example.com']}
})
};
fetch('https://api.zelto.ai/v1/experiments', 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://api.zelto.ai/v1/experiments",
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([
'name' => '<string>',
'agentId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'armAVersionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'armBVersionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'outcomeMetricIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'primaryMetricId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'stableRoutingConfirmed' => true,
'description' => '<string>',
'armAName' => '<string>',
'armBName' => '<string>',
'cohortFilters' => [
[
]
],
'assignmentUnit' => [
'kind' => 'auto'
],
'expectedArmAPercent' => 50,
'monitorGroupId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'newMonitorGroupName' => '<string>',
'notifications' => [
'emails' => [
'jsmith@example.com'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.zelto.ai/v1/experiments"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"armAVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"armBVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"outcomeMetricIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"primaryMetricId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"stableRoutingConfirmed\": true,\n \"description\": \"<string>\",\n \"armAName\": \"<string>\",\n \"armBName\": \"<string>\",\n \"cohortFilters\": [\n {}\n ],\n \"assignmentUnit\": {\n \"kind\": \"auto\"\n },\n \"expectedArmAPercent\": 50,\n \"monitorGroupId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"newMonitorGroupName\": \"<string>\",\n \"notifications\": {\n \"emails\": [\n \"jsmith@example.com\"\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.zelto.ai/v1/experiments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"armAVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"armBVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"outcomeMetricIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"primaryMetricId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"stableRoutingConfirmed\": true,\n \"description\": \"<string>\",\n \"armAName\": \"<string>\",\n \"armBName\": \"<string>\",\n \"cohortFilters\": [\n {}\n ],\n \"assignmentUnit\": {\n \"kind\": \"auto\"\n },\n \"expectedArmAPercent\": 50,\n \"monitorGroupId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"newMonitorGroupName\": \"<string>\",\n \"notifications\": {\n \"emails\": [\n \"jsmith@example.com\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zelto.ai/v1/experiments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"armAVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"armBVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"outcomeMetricIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"primaryMetricId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"stableRoutingConfirmed\": true,\n \"description\": \"<string>\",\n \"armAName\": \"<string>\",\n \"armBName\": \"<string>\",\n \"cohortFilters\": [\n {}\n ],\n \"assignmentUnit\": {\n \"kind\": \"auto\"\n },\n \"expectedArmAPercent\": 50,\n \"monitorGroupId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"newMonitorGroupName\": \"<string>\",\n \"notifications\": {\n \"emails\": [\n \"jsmith@example.com\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}Experiments
Launch an experiment
Launches immediately using server time and runs indefinitely until an operator explicitly concludes it. There is no automatic end date or statistical stopping rule. Creates or reuses a monitor group and freezes its definitions for both versions. Zelto does not route callers. Requires Observability, the Experiments v2 rollout flag, and owner/admin access.
POST
/
v1
/
experiments
Launch an experiment
curl --request POST \
--url https://api.zelto.ai/v1/experiments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"armAVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"armBVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"outcomeMetricIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"primaryMetricId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stableRoutingConfirmed": true,
"description": "<string>",
"armAName": "<string>",
"armBName": "<string>",
"cohortFilters": [
{}
],
"assignmentUnit": {
"kind": "auto"
},
"expectedArmAPercent": 50,
"monitorGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"newMonitorGroupName": "<string>",
"notifications": {
"emails": [
"jsmith@example.com"
]
}
}
'import requests
url = "https://api.zelto.ai/v1/experiments"
payload = {
"name": "<string>",
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"armAVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"armBVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"outcomeMetricIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"primaryMetricId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stableRoutingConfirmed": True,
"description": "<string>",
"armAName": "<string>",
"armBName": "<string>",
"cohortFilters": [{}],
"assignmentUnit": { "kind": "auto" },
"expectedArmAPercent": 50,
"monitorGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"newMonitorGroupName": "<string>",
"notifications": { "emails": ["jsmith@example.com"] }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
agentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
armAVersionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
armBVersionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
outcomeMetricIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
primaryMetricId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
stableRoutingConfirmed: true,
description: '<string>',
armAName: '<string>',
armBName: '<string>',
cohortFilters: [{}],
assignmentUnit: {kind: 'auto'},
expectedArmAPercent: 50,
monitorGroupId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
newMonitorGroupName: '<string>',
notifications: {emails: ['jsmith@example.com']}
})
};
fetch('https://api.zelto.ai/v1/experiments', 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://api.zelto.ai/v1/experiments",
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([
'name' => '<string>',
'agentId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'armAVersionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'armBVersionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'outcomeMetricIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'primaryMetricId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'stableRoutingConfirmed' => true,
'description' => '<string>',
'armAName' => '<string>',
'armBName' => '<string>',
'cohortFilters' => [
[
]
],
'assignmentUnit' => [
'kind' => 'auto'
],
'expectedArmAPercent' => 50,
'monitorGroupId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'newMonitorGroupName' => '<string>',
'notifications' => [
'emails' => [
'jsmith@example.com'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.zelto.ai/v1/experiments"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"armAVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"armBVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"outcomeMetricIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"primaryMetricId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"stableRoutingConfirmed\": true,\n \"description\": \"<string>\",\n \"armAName\": \"<string>\",\n \"armBName\": \"<string>\",\n \"cohortFilters\": [\n {}\n ],\n \"assignmentUnit\": {\n \"kind\": \"auto\"\n },\n \"expectedArmAPercent\": 50,\n \"monitorGroupId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"newMonitorGroupName\": \"<string>\",\n \"notifications\": {\n \"emails\": [\n \"jsmith@example.com\"\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.zelto.ai/v1/experiments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"armAVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"armBVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"outcomeMetricIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"primaryMetricId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"stableRoutingConfirmed\": true,\n \"description\": \"<string>\",\n \"armAName\": \"<string>\",\n \"armBName\": \"<string>\",\n \"cohortFilters\": [\n {}\n ],\n \"assignmentUnit\": {\n \"kind\": \"auto\"\n },\n \"expectedArmAPercent\": 50,\n \"monitorGroupId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"newMonitorGroupName\": \"<string>\",\n \"notifications\": {\n \"emails\": [\n \"jsmith@example.com\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zelto.ai/v1/experiments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"armAVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"armBVersionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"outcomeMetricIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"primaryMetricId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"stableRoutingConfirmed\": true,\n \"description\": \"<string>\",\n \"armAName\": \"<string>\",\n \"armBName\": \"<string>\",\n \"cohortFilters\": [\n {}\n ],\n \"assignmentUnit\": {\n \"kind\": \"auto\"\n },\n \"expectedArmAPercent\": 50,\n \"monitorGroupId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"newMonitorGroupName\": \"<string>\",\n \"notifications\": {\n \"emails\": [\n \"jsmith@example.com\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}{
"error": "<string>",
"message": "<string>",
"details": {}
}Authorizations
Send Authorization: Bearer YOUR_API_KEY. The key resolves to a single organization.
Body
application/json
Required string length:
1 - 255Minimum array length:
1Confirms that traffic is assigned consistently outside Zelto.
Maximum string length:
2000Maximum string length:
120Maximum string length:
120Maximum array length:
12- Option 1
- Option 2
Show child attributes
Show child attributes
Required range:
1 <= x <= 99Reuse a saved group from GET /v1/experiments/monitor-groups. outcomeMetricIds must match the group's current metricIds. Cannot be combined with newMonitorGroupName.
Save outcomeMetricIds as a reusable organization group when launching. Cannot be combined with monitorGroupId.
Required string length:
1 - 255Show child attributes
Show child attributes
Response
Experiment launched.