curl --request GET \
--url https://beta.getsales.io/unibox/v1/api/agent-scenarios/{sid} \
--header 'Authorization: Bearer <token>' \
--header 'Team-SID: <api-key>'import requests
url = "https://beta.getsales.io/unibox/v1/api/agent-scenarios/{sid}"
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/agent-scenarios/{sid}', 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/agent-scenarios/{sid}",
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/agent-scenarios/{sid}"
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/agent-scenarios/{sid}")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://beta.getsales.io/unibox/v1/api/agent-scenarios/{sid}")
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>",
"agent_sid": "<string>",
"scenario_key": "<string>",
"title": "<string>",
"trigger": "<string>",
"context": "<string>",
"context_compact": "<string>",
"steps": [
{
"id": "<string>",
"kind": "react",
"enabled": true,
"locked": true,
"when": "<string>",
"instructions": "<string>",
"params": {}
}
],
"steps_base_version": 123,
"level": "autopilot",
"conditions": [
{
"kind": "lead",
"when": "<string>",
"then": "copilot"
}
],
"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>"
},
"match_count": 1,
"last_matched_at": "<string>",
"deleted_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>"
},
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>",
"source": "platform",
"seed": {
"version": 123,
"title": "<string>",
"trigger": "<string>",
"goal": "<string>",
"max_steps": 123,
"steps": [
{
"id": "<string>",
"kind": "react",
"enabled": true,
"locked": true,
"when": "<string>",
"instructions": "<string>",
"params": {}
}
]
},
"playbook": {
"source": "platform",
"key": "<string>",
"version": 123,
"goal": "<string>",
"max_steps": 123,
"steps": [
{
"id": "<string>",
"kind": "react",
"enabled": true,
"locked": true,
"when": "<string>",
"instructions": "<string>",
"params": {}
}
],
"instructions": "<string>",
"level": "autopilot",
"conditions": [
{
"kind": "lead",
"when": "<string>",
"then": "copilot"
}
]
},
"default_changed": true
},
"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>"
}
}Get agent scenario
One scenario by sid (the team’s row) or by platform key (the seed with the team’s version merged in): the effective playbook, the seed beside it, and whether the default changed since the fork.
Contract:
- MCP tool
get_agent_scenario, registry packagemcp.unibox/agent_scenarios, mountunibox.agent. - Operation
get, response envelopeget. - Flags: read only.
curl --request GET \
--url https://beta.getsales.io/unibox/v1/api/agent-scenarios/{sid} \
--header 'Authorization: Bearer <token>' \
--header 'Team-SID: <api-key>'import requests
url = "https://beta.getsales.io/unibox/v1/api/agent-scenarios/{sid}"
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/agent-scenarios/{sid}', 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/agent-scenarios/{sid}",
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/agent-scenarios/{sid}"
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/agent-scenarios/{sid}")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://beta.getsales.io/unibox/v1/api/agent-scenarios/{sid}")
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>",
"agent_sid": "<string>",
"scenario_key": "<string>",
"title": "<string>",
"trigger": "<string>",
"context": "<string>",
"context_compact": "<string>",
"steps": [
{
"id": "<string>",
"kind": "react",
"enabled": true,
"locked": true,
"when": "<string>",
"instructions": "<string>",
"params": {}
}
],
"steps_base_version": 123,
"level": "autopilot",
"conditions": [
{
"kind": "lead",
"when": "<string>",
"then": "copilot"
}
],
"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>"
},
"match_count": 1,
"last_matched_at": "<string>",
"deleted_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>"
},
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>",
"source": "platform",
"seed": {
"version": 123,
"title": "<string>",
"trigger": "<string>",
"goal": "<string>",
"max_steps": 123,
"steps": [
{
"id": "<string>",
"kind": "react",
"enabled": true,
"locked": true,
"when": "<string>",
"instructions": "<string>",
"params": {}
}
]
},
"playbook": {
"source": "platform",
"key": "<string>",
"version": 123,
"goal": "<string>",
"max_steps": 123,
"steps": [
{
"id": "<string>",
"kind": "react",
"enabled": true,
"locked": true,
"when": "<string>",
"instructions": "<string>",
"params": {}
}
],
"instructions": "<string>",
"level": "autopilot",
"conditions": [
{
"kind": "lead",
"when": "<string>",
"then": "copilot"
}
]
},
"default_changed": true
},
"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
ub_sc_ sid or key: interested, meeting_request, info_request, referral, not_now, out_of_office, auto_reply, wrong_person, reschedule_request, cancel_request, other_low_signal, not_interested, objection, do_not_contact, followup_no_reply, signal_followup.
1 - 64Query Parameters
The AI SDR whose scenario it is (ub_ag_…); with a platform key, which agent's version. Left out, the team's default agent.
18^ub_ag_