Get agent rules
curl --request GET \
--url https://beta.getsales.io/unibox/v1/api/agents/{sid}/rules \
--header 'Authorization: Bearer <token>' \
--header 'Team-SID: <api-key>'import requests
url = "https://beta.getsales.io/unibox/v1/api/agents/{sid}/rules"
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Bearer <token>', 'Team-SID': '<api-key>'}
};
fetch('https://beta.getsales.io/unibox/v1/api/agents/{sid}/rules', 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://beta.getsales.io/unibox/v1/api/agents/{sid}/rules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Team-SID: <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"
"net/http"
"io"
)
func main() {
url := "https://beta.getsales.io/unibox/v1/api/agents/{sid}/rules"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Team-SID", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://beta.getsales.io/unibox/v1/api/agents/{sid}/rules")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://beta.getsales.io/unibox/v1/api/agents/{sid}/rules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "get",
"item": {
"sid": "<string>",
"team_sid": "<string>",
"state": "setup_required",
"mode": "copilot",
"name": "<string>",
"is_default": true,
"knowledge": {
"booking_mode": "link",
"source_urls": [
"<string>"
],
"interview_transcript_ref": "<string>"
},
"brief": {
"text": "<string>",
"compact": "<string>",
"digest": "<string>"
},
"settings": {
"max_auto_messages_per_conversation": 10,
"followups_for_synced_threads": true,
"escalation_triggers": [
"pricing_question"
],
"classification_merge_seconds": 305,
"messages_recency_days": 183,
"custom_escalation_triggers": [
"<string>"
],
"after_person_message": "plan_followups",
"person_followups_count": 2,
"person_followups_every_days": 15,
"person_followups_then": "task",
"reply_split": "one_message",
"credits_cap_per_conversation": 500,
"handoff_notify_email": true,
"reply_language": "lead",
"learning": {
"from_history": true,
"from_own_sends": true,
"from_approved_edits": true,
"edits_join": "after_ok"
}
},
"created_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"actor_name": "<string>",
"oauth_client_sid": "<string>",
"reason": "<string>",
"cluster_id": 123,
"trace_id": "<string>"
},
"rules": {
"reply_words": {
"linkedin": {
"min": 102,
"max": 102
},
"email": {
"min": 102,
"max": 102
}
},
"meeting_ask": "suggest_call_link_on_request",
"confirm_named_time": true,
"answer_then_call": true,
"acknowledge_low_signal": true,
"reply_delay_minutes": {
"min": 30,
"max": 30
},
"quiet_hours": {
"from": "<string>",
"to": "<string>"
},
"weekends": true,
"followups": 3,
"followup_days": 7,
"something_new": true,
"checks": {
"unfilled_fields": true,
"same_text_twice": true,
"link_before_reply": true,
"stop_words": true,
"long_dashes": true,
"template_after_reply": true,
"signature_block": true
}
},
"hosts": [
{
"id": "<string>",
"kind": "sender",
"member_sid": "<string>",
"name": "<string>",
"link": "<string>",
"introduced_as": "<string>",
"scenario_keys": [
"<string>"
]
}
],
"goal": {
"kind": "call",
"words": "<string>"
},
"golden_set": {
"words": [
{
"never": "<string>",
"instead": "<string>"
}
],
"voice": {
"summary": "<string>",
"length": "<string>",
"questions": "<string>",
"register": "<string>",
"sign_off": "<string>",
"formed_from": 123,
"formed_at": "<string>",
"model": "<string>",
"pinned": [
"<string>"
]
}
},
"setup": {
"skipped": [
"brief"
]
},
"llm_config": {
"classification_model": "<string>",
"agent_model": "<string>"
},
"setup_completed_at": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
},
"included": {},
"includes": [
"<string>"
],
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}agents
Get agent rules
An AI SDR’s Rules (by sid), what every reply keeps to (item.rules): the length bands, how it asks for a meeting, the wait and the quiet hours, the follow-ups, the checks before it sends.
Contract:
- MCP tool
get_agent_rules, registry packagemcp.unibox/agents, mountunibox.agent. - Operation
get, response envelopeget. - Flags: read only.
GET
/
api
/
agents
/
{sid}
/
rules
Get agent rules
curl --request GET \
--url https://beta.getsales.io/unibox/v1/api/agents/{sid}/rules \
--header 'Authorization: Bearer <token>' \
--header 'Team-SID: <api-key>'import requests
url = "https://beta.getsales.io/unibox/v1/api/agents/{sid}/rules"
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Bearer <token>', 'Team-SID': '<api-key>'}
};
fetch('https://beta.getsales.io/unibox/v1/api/agents/{sid}/rules', 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://beta.getsales.io/unibox/v1/api/agents/{sid}/rules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Team-SID: <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"
"net/http"
"io"
)
func main() {
url := "https://beta.getsales.io/unibox/v1/api/agents/{sid}/rules"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Team-SID", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://beta.getsales.io/unibox/v1/api/agents/{sid}/rules")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://beta.getsales.io/unibox/v1/api/agents/{sid}/rules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "get",
"item": {
"sid": "<string>",
"team_sid": "<string>",
"state": "setup_required",
"mode": "copilot",
"name": "<string>",
"is_default": true,
"knowledge": {
"booking_mode": "link",
"source_urls": [
"<string>"
],
"interview_transcript_ref": "<string>"
},
"brief": {
"text": "<string>",
"compact": "<string>",
"digest": "<string>"
},
"settings": {
"max_auto_messages_per_conversation": 10,
"followups_for_synced_threads": true,
"escalation_triggers": [
"pricing_question"
],
"classification_merge_seconds": 305,
"messages_recency_days": 183,
"custom_escalation_triggers": [
"<string>"
],
"after_person_message": "plan_followups",
"person_followups_count": 2,
"person_followups_every_days": 15,
"person_followups_then": "task",
"reply_split": "one_message",
"credits_cap_per_conversation": 500,
"handoff_notify_email": true,
"reply_language": "lead",
"learning": {
"from_history": true,
"from_own_sends": true,
"from_approved_edits": true,
"edits_join": "after_ok"
}
},
"created_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"actor_name": "<string>",
"oauth_client_sid": "<string>",
"reason": "<string>",
"cluster_id": 123,
"trace_id": "<string>"
},
"rules": {
"reply_words": {
"linkedin": {
"min": 102,
"max": 102
},
"email": {
"min": 102,
"max": 102
}
},
"meeting_ask": "suggest_call_link_on_request",
"confirm_named_time": true,
"answer_then_call": true,
"acknowledge_low_signal": true,
"reply_delay_minutes": {
"min": 30,
"max": 30
},
"quiet_hours": {
"from": "<string>",
"to": "<string>"
},
"weekends": true,
"followups": 3,
"followup_days": 7,
"something_new": true,
"checks": {
"unfilled_fields": true,
"same_text_twice": true,
"link_before_reply": true,
"stop_words": true,
"long_dashes": true,
"template_after_reply": true,
"signature_block": true
}
},
"hosts": [
{
"id": "<string>",
"kind": "sender",
"member_sid": "<string>",
"name": "<string>",
"link": "<string>",
"introduced_as": "<string>",
"scenario_keys": [
"<string>"
]
}
],
"goal": {
"kind": "call",
"words": "<string>"
},
"golden_set": {
"words": [
{
"never": "<string>",
"instead": "<string>"
}
],
"voice": {
"summary": "<string>",
"length": "<string>",
"questions": "<string>",
"register": "<string>",
"sign_off": "<string>",
"formed_from": 123,
"formed_at": "<string>",
"model": "<string>",
"pinned": [
"<string>"
]
}
},
"setup": {
"skipped": [
"brief"
]
},
"llm_config": {
"classification_model": "<string>",
"agent_model": "<string>"
},
"setup_completed_at": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
},
"included": {},
"includes": [
"<string>"
],
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}Authorizations
Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.
Team scope for tokens that do not carry one. Ignored when the token already names a team.
Path Parameters
The agent (ub_ag_…).
Required string length:
18Pattern:
^ub_ag_