Start an agent A/B experiment
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/agents/{id}/experiments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"variant_a_version_id": "<string>",
"variant_b_version_id": "<string>",
"traffic_split_pct": 50
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/agents/{id}/experiments"
payload = {
"name": "<string>",
"variant_a_version_id": "<string>",
"variant_b_version_id": "<string>",
"traffic_split_pct": 50
}
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>',
variant_a_version_id: '<string>',
variant_b_version_id: '<string>',
traffic_split_pct: 50
})
};
fetch('https://api.orbit.devotel.io/api/v1/agents/{id}/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.orbit.devotel.io/api/v1/agents/{id}/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>',
'variant_a_version_id' => '<string>',
'variant_b_version_id' => '<string>',
'traffic_split_pct' => 50
]),
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.orbit.devotel.io/api/v1/agents/{id}/experiments"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"variant_a_version_id\": \"<string>\",\n \"variant_b_version_id\": \"<string>\",\n \"traffic_split_pct\": 50\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.orbit.devotel.io/api/v1/agents/{id}/experiments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"variant_a_version_id\": \"<string>\",\n \"variant_b_version_id\": \"<string>\",\n \"traffic_split_pct\": 50\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/agents/{id}/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 \"variant_a_version_id\": \"<string>\",\n \"variant_b_version_id\": \"<string>\",\n \"traffic_split_pct\": 50\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"agent_id": "<string>",
"name": "<string>",
"variant_a_version_id": "<string>",
"variant_b_version_id": "<string>",
"traffic_split_pct": 123,
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"created_by_user_id": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}Agents
Start an agent A/B experiment
Start a new A/B experiment that routes a configurable share of inbound conversations to variant B (a second prompt version) while the rest see variant A, measuring a single conversion metric. Only one experiment may be active per agent — starting another returns 409. Requires owner, admin, or developer.
POST
/
api
/
v1
/
agents
/
{id}
/
experiments
Start an agent A/B experiment
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/agents/{id}/experiments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"variant_a_version_id": "<string>",
"variant_b_version_id": "<string>",
"traffic_split_pct": 50
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/agents/{id}/experiments"
payload = {
"name": "<string>",
"variant_a_version_id": "<string>",
"variant_b_version_id": "<string>",
"traffic_split_pct": 50
}
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>',
variant_a_version_id: '<string>',
variant_b_version_id: '<string>',
traffic_split_pct: 50
})
};
fetch('https://api.orbit.devotel.io/api/v1/agents/{id}/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.orbit.devotel.io/api/v1/agents/{id}/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>',
'variant_a_version_id' => '<string>',
'variant_b_version_id' => '<string>',
'traffic_split_pct' => 50
]),
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.orbit.devotel.io/api/v1/agents/{id}/experiments"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"variant_a_version_id\": \"<string>\",\n \"variant_b_version_id\": \"<string>\",\n \"traffic_split_pct\": 50\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.orbit.devotel.io/api/v1/agents/{id}/experiments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"variant_a_version_id\": \"<string>\",\n \"variant_b_version_id\": \"<string>\",\n \"traffic_split_pct\": 50\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/agents/{id}/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 \"variant_a_version_id\": \"<string>\",\n \"variant_b_version_id\": \"<string>\",\n \"traffic_split_pct\": 50\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"agent_id": "<string>",
"name": "<string>",
"variant_a_version_id": "<string>",
"variant_b_version_id": "<string>",
"traffic_split_pct": 123,
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"created_by_user_id": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Path Parameters
Agent identifier (Devotel agent_xxx id).
Body
application/json
Human-readable experiment name.
Required string length:
1 - 200Prompt version id for the control arm (A).
Prompt version id for the treatment arm (B). Must differ from A.
The single outcome the experiment optimises for.
Available options:
reply_received, goal_completion, human_handoff_avoided Percentage of new contacts routed to variant B (1–99, default 50).
Required range:
1 <= x <= 99⌘I