Create an agent squad
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/agents/squads/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Support triage",
"classifier_agent_id": "agt_classifier",
"members": [
{
"agent_id": "agt_billing",
"intent_labels": [
"billing",
"refund"
],
"description": "Handles billing and refund questions."
},
{
"agent_id": "agt_tech",
"intent_labels": [
"bug",
"how-to"
],
"description": "Handles technical support."
}
],
"fallback_agent_id": "agt_tech"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/agents/squads/"
payload = {
"name": "Support triage",
"classifier_agent_id": "agt_classifier",
"members": [
{
"agent_id": "agt_billing",
"intent_labels": ["billing", "refund"],
"description": "Handles billing and refund questions."
},
{
"agent_id": "agt_tech",
"intent_labels": ["bug", "how-to"],
"description": "Handles technical support."
}
],
"fallback_agent_id": "agt_tech"
}
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: 'Support triage',
classifier_agent_id: 'agt_classifier',
members: [
{
agent_id: 'agt_billing',
intent_labels: ['billing', 'refund'],
description: 'Handles billing and refund questions.'
},
{
agent_id: 'agt_tech',
intent_labels: ['bug', 'how-to'],
description: 'Handles technical support.'
}
],
fallback_agent_id: 'agt_tech'
})
};
fetch('https://api.orbit.devotel.io/api/v1/agents/squads/', 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/squads/",
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' => 'Support triage',
'classifier_agent_id' => 'agt_classifier',
'members' => [
[
'agent_id' => 'agt_billing',
'intent_labels' => [
'billing',
'refund'
],
'description' => 'Handles billing and refund questions.'
],
[
'agent_id' => 'agt_tech',
'intent_labels' => [
'bug',
'how-to'
],
'description' => 'Handles technical support.'
]
],
'fallback_agent_id' => 'agt_tech'
]),
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/squads/"
payload := strings.NewReader("{\n \"name\": \"Support triage\",\n \"classifier_agent_id\": \"agt_classifier\",\n \"members\": [\n {\n \"agent_id\": \"agt_billing\",\n \"intent_labels\": [\n \"billing\",\n \"refund\"\n ],\n \"description\": \"Handles billing and refund questions.\"\n },\n {\n \"agent_id\": \"agt_tech\",\n \"intent_labels\": [\n \"bug\",\n \"how-to\"\n ],\n \"description\": \"Handles technical support.\"\n }\n ],\n \"fallback_agent_id\": \"agt_tech\"\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/squads/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Support triage\",\n \"classifier_agent_id\": \"agt_classifier\",\n \"members\": [\n {\n \"agent_id\": \"agt_billing\",\n \"intent_labels\": [\n \"billing\",\n \"refund\"\n ],\n \"description\": \"Handles billing and refund questions.\"\n },\n {\n \"agent_id\": \"agt_tech\",\n \"intent_labels\": [\n \"bug\",\n \"how-to\"\n ],\n \"description\": \"Handles technical support.\"\n }\n ],\n \"fallback_agent_id\": \"agt_tech\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/agents/squads/")
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\": \"Support triage\",\n \"classifier_agent_id\": \"agt_classifier\",\n \"members\": [\n {\n \"agent_id\": \"agt_billing\",\n \"intent_labels\": [\n \"billing\",\n \"refund\"\n ],\n \"description\": \"Handles billing and refund questions.\"\n },\n {\n \"agent_id\": \"agt_tech\",\n \"intent_labels\": [\n \"bug\",\n \"how-to\"\n ],\n \"description\": \"Handles technical support.\"\n }\n ],\n \"fallback_agent_id\": \"agt_tech\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"classifier_agent_id": "<string>",
"members": [
{
"agent_id": "<string>",
"intent_labels": [
"<string>"
],
"description": "<string>"
}
],
"fallback_agent_id": "<string>",
"active": true,
"max_cost_per_day_cents": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Agents
Create an agent squad
Create a squad that routes inbound conversations across 2–6 member agents. A classifier agent maps each message to one member’s intent labels, with an optional fallback agent for unmatched intents. Supply name, classifier_agent_id, and the members array; the classifier must not also be a member.
POST
/
api
/
v1
/
agents
/
squads
/
Create an agent squad
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/agents/squads/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Support triage",
"classifier_agent_id": "agt_classifier",
"members": [
{
"agent_id": "agt_billing",
"intent_labels": [
"billing",
"refund"
],
"description": "Handles billing and refund questions."
},
{
"agent_id": "agt_tech",
"intent_labels": [
"bug",
"how-to"
],
"description": "Handles technical support."
}
],
"fallback_agent_id": "agt_tech"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/agents/squads/"
payload = {
"name": "Support triage",
"classifier_agent_id": "agt_classifier",
"members": [
{
"agent_id": "agt_billing",
"intent_labels": ["billing", "refund"],
"description": "Handles billing and refund questions."
},
{
"agent_id": "agt_tech",
"intent_labels": ["bug", "how-to"],
"description": "Handles technical support."
}
],
"fallback_agent_id": "agt_tech"
}
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: 'Support triage',
classifier_agent_id: 'agt_classifier',
members: [
{
agent_id: 'agt_billing',
intent_labels: ['billing', 'refund'],
description: 'Handles billing and refund questions.'
},
{
agent_id: 'agt_tech',
intent_labels: ['bug', 'how-to'],
description: 'Handles technical support.'
}
],
fallback_agent_id: 'agt_tech'
})
};
fetch('https://api.orbit.devotel.io/api/v1/agents/squads/', 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/squads/",
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' => 'Support triage',
'classifier_agent_id' => 'agt_classifier',
'members' => [
[
'agent_id' => 'agt_billing',
'intent_labels' => [
'billing',
'refund'
],
'description' => 'Handles billing and refund questions.'
],
[
'agent_id' => 'agt_tech',
'intent_labels' => [
'bug',
'how-to'
],
'description' => 'Handles technical support.'
]
],
'fallback_agent_id' => 'agt_tech'
]),
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/squads/"
payload := strings.NewReader("{\n \"name\": \"Support triage\",\n \"classifier_agent_id\": \"agt_classifier\",\n \"members\": [\n {\n \"agent_id\": \"agt_billing\",\n \"intent_labels\": [\n \"billing\",\n \"refund\"\n ],\n \"description\": \"Handles billing and refund questions.\"\n },\n {\n \"agent_id\": \"agt_tech\",\n \"intent_labels\": [\n \"bug\",\n \"how-to\"\n ],\n \"description\": \"Handles technical support.\"\n }\n ],\n \"fallback_agent_id\": \"agt_tech\"\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/squads/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Support triage\",\n \"classifier_agent_id\": \"agt_classifier\",\n \"members\": [\n {\n \"agent_id\": \"agt_billing\",\n \"intent_labels\": [\n \"billing\",\n \"refund\"\n ],\n \"description\": \"Handles billing and refund questions.\"\n },\n {\n \"agent_id\": \"agt_tech\",\n \"intent_labels\": [\n \"bug\",\n \"how-to\"\n ],\n \"description\": \"Handles technical support.\"\n }\n ],\n \"fallback_agent_id\": \"agt_tech\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/agents/squads/")
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\": \"Support triage\",\n \"classifier_agent_id\": \"agt_classifier\",\n \"members\": [\n {\n \"agent_id\": \"agt_billing\",\n \"intent_labels\": [\n \"billing\",\n \"refund\"\n ],\n \"description\": \"Handles billing and refund questions.\"\n },\n {\n \"agent_id\": \"agt_tech\",\n \"intent_labels\": [\n \"bug\",\n \"how-to\"\n ],\n \"description\": \"Handles technical support.\"\n }\n ],\n \"fallback_agent_id\": \"agt_tech\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"classifier_agent_id": "<string>",
"members": [
{
"agent_id": "<string>",
"intent_labels": [
"<string>"
],
"description": "<string>"
}
],
"fallback_agent_id": "<string>",
"active": true,
"max_cost_per_day_cents": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Body
application/json
Required string length:
1 - 200Agent that classifies each inbound to a member intent. Must not also be a member.
Required array length:
2 - 6 elementsShow child attributes
Show child attributes
Maximum string length:
2000Agent used when no member intent matches. Must not equal the classifier.
Optional per-day spend cap in cents.
⌘I